GetAndLockRequest
extends Message
in package
Generated from protobuf message <code>couchbase.kv.v1.GetAndLockRequest</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>
- $compression : mixed
- Generated from protobuf field <code>optional .couchbase.kv.v1.CompressionEnabled compression = 6;</code>
- $key : mixed
- Generated from protobuf field <code>string key = 4;</code>
- $lock_time : mixed
- Generated from protobuf field <code>uint32 lock_time = 5;</code>
- $scope_name : mixed
- Generated from protobuf field <code>string scope_name = 2;</code>
- __construct() : mixed
- Constructor.
- clearCompression() : 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>
- getCompression() : int
- Generated from protobuf field <code>optional .couchbase.kv.v1.CompressionEnabled compression = 6;</code>
- getKey() : string
- Generated from protobuf field <code>string key = 4;</code>
- getLockTime() : int
- Generated from protobuf field <code>uint32 lock_time = 5;</code>
- getScopeName() : string
- Generated from protobuf field <code>string scope_name = 2;</code>
- hasCompression() : 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>
- setCompression() : $this
- Generated from protobuf field <code>optional .couchbase.kv.v1.CompressionEnabled compression = 6;</code>
- setKey() : $this
- Generated from protobuf field <code>string key = 4;</code>
- setLockTime() : $this
- Generated from protobuf field <code>uint32 lock_time = 5;</code>
- setScopeName() : $this
- Generated from protobuf field <code>string scope_name = 2;</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
= ''
$compression
Generated from protobuf field <code>optional .couchbase.kv.v1.CompressionEnabled compression = 6;</code>
protected
mixed
$compression
= null
$key
Generated from protobuf field <code>string key = 4;</code>
protected
mixed
$key
= ''
$lock_time
Generated from protobuf field <code>uint32 lock_time = 5;</code>
protected
mixed
$lock_time
= 0
$scope_name
Generated from protobuf field <code>string scope_name = 2;</code>
protected
mixed
$scope_name
= ''
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 int $lock_time @type int $compression}
Return values
mixed —clearCompression()
public
clearCompression() : mixed
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 —getCompression()
Generated from protobuf field <code>optional .couchbase.kv.v1.CompressionEnabled compression = 6;</code>
public
getCompression() : int
Return values
int —getKey()
Generated from protobuf field <code>string key = 4;</code>
public
getKey() : string
Return values
string —getLockTime()
Generated from protobuf field <code>uint32 lock_time = 5;</code>
public
getLockTime() : int
Return values
int —getScopeName()
Generated from protobuf field <code>string scope_name = 2;</code>
public
getScopeName() : string
Return values
string —hasCompression()
public
hasCompression() : mixed
Return values
mixed —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 —setCompression()
Generated from protobuf field <code>optional .couchbase.kv.v1.CompressionEnabled compression = 6;</code>
public
setCompression(int $var) : $this
Parameters
- $var : int
Return values
$this —setKey()
Generated from protobuf field <code>string key = 4;</code>
public
setKey(string $var) : $this
Parameters
- $var : string
Return values
$this —setLockTime()
Generated from protobuf field <code>uint32 lock_time = 5;</code>
public
setLockTime(int $var) : $this
Parameters
- $var : int
Return values
$this —setScopeName()
Generated from protobuf field <code>string scope_name = 2;</code>
public
setScopeName(string $var) : $this
Parameters
- $var : string