Documentation

AnalyticsQueryRequest extends Message
in package

Generated from protobuf message <code>couchbase.analytics.v1.AnalyticsQueryRequest</code>

Table of Contents

$bucket_name  : mixed
Generated from protobuf field <code>optional string bucket_name = 8;</code>
$client_context_id  : mixed
Generated from protobuf field <code>optional string client_context_id = 3;</code>
$priority  : mixed
Generated from protobuf field <code>optional bool priority = 4;</code>
$read_only  : mixed
Generated from protobuf field <code>optional bool read_only = 2;</code>
$scan_consistency  : mixed
Generated from protobuf field <code>optional .couchbase.analytics.v1.AnalyticsQueryRequest.ScanConsistency scan_consistency = 5;</code>
$scope_name  : mixed
Generated from protobuf field <code>optional string scope_name = 9;</code>
$statement  : mixed
Generated from protobuf field <code>string statement = 1;</code>
$named_parameters  : mixed
Generated from protobuf field <code>map<string, bytes> named_parameters = 7;</code>
$positional_parameters  : mixed
Generated from protobuf field <code>repeated bytes positional_parameters = 6;</code>
__construct()  : mixed
Constructor.
clearBucketName()  : mixed
clearClientContextId()  : mixed
clearPriority()  : mixed
clearReadOnly()  : mixed
clearScanConsistency()  : mixed
clearScopeName()  : mixed
getBucketName()  : string
Generated from protobuf field <code>optional string bucket_name = 8;</code>
getClientContextId()  : string
Generated from protobuf field <code>optional string client_context_id = 3;</code>
getNamedParameters()  : MapField
Generated from protobuf field <code>map<string, bytes> named_parameters = 7;</code>
getPositionalParameters()  : RepeatedField
Generated from protobuf field <code>repeated bytes positional_parameters = 6;</code>
getPriority()  : bool
Generated from protobuf field <code>optional bool priority = 4;</code>
getReadOnly()  : bool
Generated from protobuf field <code>optional bool read_only = 2;</code>
getScanConsistency()  : int
Generated from protobuf field <code>optional .couchbase.analytics.v1.AnalyticsQueryRequest.ScanConsistency scan_consistency = 5;</code>
getScopeName()  : string
Generated from protobuf field <code>optional string scope_name = 9;</code>
getStatement()  : string
Generated from protobuf field <code>string statement = 1;</code>
hasBucketName()  : mixed
hasClientContextId()  : mixed
hasPriority()  : mixed
hasReadOnly()  : mixed
hasScanConsistency()  : mixed
hasScopeName()  : mixed
setBucketName()  : $this
Generated from protobuf field <code>optional string bucket_name = 8;</code>
setClientContextId()  : $this
Generated from protobuf field <code>optional string client_context_id = 3;</code>
setNamedParameters()  : $this
Generated from protobuf field <code>map<string, bytes> named_parameters = 7;</code>
setPositionalParameters()  : $this
Generated from protobuf field <code>repeated bytes positional_parameters = 6;</code>
setPriority()  : $this
Generated from protobuf field <code>optional bool priority = 4;</code>
setReadOnly()  : $this
Generated from protobuf field <code>optional bool read_only = 2;</code>
setScanConsistency()  : $this
Generated from protobuf field <code>optional .couchbase.analytics.v1.AnalyticsQueryRequest.ScanConsistency scan_consistency = 5;</code>
setScopeName()  : $this
Generated from protobuf field <code>optional string scope_name = 9;</code>
setStatement()  : $this
Generated from protobuf field <code>string statement = 1;</code>

Properties

$bucket_name

Generated from protobuf field <code>optional string bucket_name = 8;</code>

protected mixed $bucket_name = null

$client_context_id

Generated from protobuf field <code>optional string client_context_id = 3;</code>

protected mixed $client_context_id = null

$priority

Generated from protobuf field <code>optional bool priority = 4;</code>

protected mixed $priority = null

$read_only

Generated from protobuf field <code>optional bool read_only = 2;</code>

protected mixed $read_only = null

$scan_consistency

Generated from protobuf field <code>optional .couchbase.analytics.v1.AnalyticsQueryRequest.ScanConsistency scan_consistency = 5;</code>

protected mixed $scan_consistency = null

$scope_name

Generated from protobuf field <code>optional string scope_name = 9;</code>

protected mixed $scope_name = null

$statement

Generated from protobuf field <code>string statement = 1;</code>

protected mixed $statement = ''

$named_parameters

Generated from protobuf field <code>map<string, bytes> named_parameters = 7;</code>

private mixed $named_parameters

$positional_parameters

Generated from protobuf field <code>repeated bytes positional_parameters = 6;</code>

private mixed $positional_parameters

Methods

__construct()

Constructor.

public __construct([array<string|int, mixed> $data = NULL ]) : mixed
Parameters
$data : array<string|int, mixed> = NULL

{ Optional. Data for populating the Message object.

@type string $bucket_name
@type string $scope_name
@type string $statement
@type bool $read_only
@type string $client_context_id
@type bool $priority
@type int $scan_consistency
@type array<string>|\Google\Protobuf\Internal\RepeatedField $positional_parameters
@type array|\Google\Protobuf\Internal\MapField $named_parameters

}

Return values
mixed —

getBucketName()

Generated from protobuf field <code>optional string bucket_name = 8;</code>

public getBucketName() : string
Return values
string —

getClientContextId()

Generated from protobuf field <code>optional string client_context_id = 3;</code>

public getClientContextId() : string
Return values
string —

getNamedParameters()

Generated from protobuf field <code>map<string, bytes> named_parameters = 7;</code>

public getNamedParameters() : MapField
Return values
MapField —

getPositionalParameters()

Generated from protobuf field <code>repeated bytes positional_parameters = 6;</code>

public getPositionalParameters() : RepeatedField
Return values
RepeatedField —

getPriority()

Generated from protobuf field <code>optional bool priority = 4;</code>

public getPriority() : bool
Return values
bool —

getReadOnly()

Generated from protobuf field <code>optional bool read_only = 2;</code>

public getReadOnly() : bool
Return values
bool —

getScanConsistency()

Generated from protobuf field <code>optional .couchbase.analytics.v1.AnalyticsQueryRequest.ScanConsistency scan_consistency = 5;</code>

public getScanConsistency() : int
Return values
int —

getScopeName()

Generated from protobuf field <code>optional string scope_name = 9;</code>

public getScopeName() : string
Return values
string —

getStatement()

Generated from protobuf field <code>string statement = 1;</code>

public getStatement() : string
Return values
string —

setBucketName()

Generated from protobuf field <code>optional string bucket_name = 8;</code>

public setBucketName(string $var) : $this
Parameters
$var : string
Return values
$this —

setClientContextId()

Generated from protobuf field <code>optional string client_context_id = 3;</code>

public setClientContextId(string $var) : $this
Parameters
$var : string
Return values
$this —

setNamedParameters()

Generated from protobuf field <code>map<string, bytes> named_parameters = 7;</code>

public setNamedParameters(array<string|int, mixed>|MapField $var) : $this
Parameters
$var : array<string|int, mixed>|MapField
Return values
$this —

setPositionalParameters()

Generated from protobuf field <code>repeated bytes positional_parameters = 6;</code>

public setPositionalParameters(array<string|int, string>|RepeatedField $var) : $this
Parameters
$var : array<string|int, string>|RepeatedField
Return values
$this —

setPriority()

Generated from protobuf field <code>optional bool priority = 4;</code>

public setPriority(bool $var) : $this
Parameters
$var : bool
Return values
$this —

setReadOnly()

Generated from protobuf field <code>optional bool read_only = 2;</code>

public setReadOnly(bool $var) : $this
Parameters
$var : bool
Return values
$this —

setScanConsistency()

Generated from protobuf field <code>optional .couchbase.analytics.v1.AnalyticsQueryRequest.ScanConsistency scan_consistency = 5;</code>

public setScanConsistency(int $var) : $this
Parameters
$var : int
Return values
$this —

setScopeName()

Generated from protobuf field <code>optional string scope_name = 9;</code>

public setScopeName(string $var) : $this
Parameters
$var : string
Return values
$this —

setStatement()

Generated from protobuf field <code>string statement = 1;</code>

public setStatement(string $var) : $this
Parameters
$var : string
Return values
$this — 

        

        
    




    

    

                

    

        

            
Search results