Documentation

LookupInRequest extends Message
in package

Generated from protobuf message <code>couchbase.kv.v1.LookupInRequest</code>

Table of Contents

$bucket_name  : mixed
Generated from protobuf field <code>string bucket_name = 1;</code>
$collection_name  : mixed
Generated from protobuf field <code>string collection_name = 3;</code>
$flags  : mixed
Generated from protobuf field <code>optional .couchbase.kv.v1.LookupInRequest.Flags flags = 6;</code>
$key  : mixed
Generated from protobuf field <code>string key = 4;</code>
$scope_name  : mixed
Generated from protobuf field <code>string scope_name = 2;</code>
$specs  : mixed
Generated from protobuf field <code>repeated .couchbase.kv.v1.LookupInRequest.Spec specs = 5;</code>
__construct()  : mixed
Constructor.
clearFlags()  : mixed
getBucketName()  : string
Generated from protobuf field <code>string bucket_name = 1;</code>
getCollectionName()  : string
Generated from protobuf field <code>string collection_name = 3;</code>
getFlags()  : Flags|null
Generated from protobuf field <code>optional .couchbase.kv.v1.LookupInRequest.Flags flags = 6;</code>
getKey()  : string
Generated from protobuf field <code>string key = 4;</code>
getScopeName()  : string
Generated from protobuf field <code>string scope_name = 2;</code>
getSpecs()  : RepeatedField
Generated from protobuf field <code>repeated .couchbase.kv.v1.LookupInRequest.Spec specs = 5;</code>
hasFlags()  : mixed
setBucketName()  : $this
Generated from protobuf field <code>string bucket_name = 1;</code>
setCollectionName()  : $this
Generated from protobuf field <code>string collection_name = 3;</code>
setFlags()  : $this
Generated from protobuf field <code>optional .couchbase.kv.v1.LookupInRequest.Flags flags = 6;</code>
setKey()  : $this
Generated from protobuf field <code>string key = 4;</code>
setScopeName()  : $this
Generated from protobuf field <code>string scope_name = 2;</code>
setSpecs()  : $this
Generated from protobuf field <code>repeated .couchbase.kv.v1.LookupInRequest.Spec specs = 5;</code>

Properties

$bucket_name

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

protected mixed $bucket_name = ''

$collection_name

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

protected mixed $collection_name = ''

$flags

Generated from protobuf field <code>optional .couchbase.kv.v1.LookupInRequest.Flags flags = 6;</code>

protected mixed $flags = null

$key

Generated from protobuf field <code>string key = 4;</code>

protected mixed $key = ''

$scope_name

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

protected mixed $scope_name = ''

$specs

Generated from protobuf field <code>repeated .couchbase.kv.v1.LookupInRequest.Spec specs = 5;</code>

private mixed $specs

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 $collection_name
@type string $key
@type array<\Couchbase\Protostellar\Generated\KV\V1\LookupInRequest\Spec>|\Google\Protobuf\Internal\RepeatedField $specs
@type \Couchbase\Protostellar\Generated\KV\V1\LookupInRequest\Flags $flags

}

Return values
mixed

getBucketName()

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

public getBucketName() : string
Return values
string

getCollectionName()

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

public getCollectionName() : string
Return values
string

getFlags()

Generated from protobuf field <code>optional .couchbase.kv.v1.LookupInRequest.Flags flags = 6;</code>

public getFlags() : Flags|null
Return values
Flags|null

getKey()

Generated from protobuf field <code>string key = 4;</code>

public getKey() : string
Return values
string

getScopeName()

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

public getScopeName() : string
Return values
string

getSpecs()

Generated from protobuf field <code>repeated .couchbase.kv.v1.LookupInRequest.Spec specs = 5;</code>

public getSpecs() : RepeatedField
Return values
RepeatedField

setBucketName()

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

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

setCollectionName()

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

public setCollectionName(string $var) : $this
Parameters
$var : string
Return values
$this

setFlags()

Generated from protobuf field <code>optional .couchbase.kv.v1.LookupInRequest.Flags flags = 6;</code>

public setFlags(Flags $var) : $this
Parameters
$var : Flags
Return values
$this

setKey()

Generated from protobuf field <code>string key = 4;</code>

public setKey(string $var) : $this
Parameters
$var : string
Return values
$this

setScopeName()

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

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

setSpecs()

Generated from protobuf field <code>repeated .couchbase.kv.v1.LookupInRequest.Spec specs = 5;</code>

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

        

Search results