Documentation

TouchRequest extends Message
in package

Generated from protobuf message <code>couchbase.kv.v1.TouchRequest</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>
$expiry  : mixed
$key  : mixed
Generated from protobuf field <code>string key = 4;</code>
$scope_name  : mixed
Generated from protobuf field <code>string scope_name = 2;</code>
__construct()  : mixed
Constructor.
getBucketName()  : string
Generated from protobuf field <code>string bucket_name = 1;</code>
getCollectionName()  : string
Generated from protobuf field <code>string collection_name = 3;</code>
getExpiry()  : string
getExpirySecs()  : int
Generated from protobuf field <code>uint32 expiry_secs = 6;</code>
getExpiryTime()  : Timestamp|null
Generated from protobuf field <code>.google.protobuf.Timestamp expiry_time = 5;</code>
getKey()  : string
Generated from protobuf field <code>string key = 4;</code>
getScopeName()  : string
Generated from protobuf field <code>string scope_name = 2;</code>
hasExpirySecs()  : mixed
hasExpiryTime()  : 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>
setExpirySecs()  : $this
Generated from protobuf field <code>uint32 expiry_secs = 6;</code>
setExpiryTime()  : $this
Generated from protobuf field <code>.google.protobuf.Timestamp expiry_time = 5;</code>
setKey()  : $this
Generated from protobuf field <code>string key = 4;</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 = ''

$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 = ''

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 \Google\Protobuf\Timestamp $expiry_time
@type int $expiry_secs

}

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 —

getExpiry()

public getExpiry() : string
Return values
string —

getExpirySecs()

Generated from protobuf field <code>uint32 expiry_secs = 6;</code>

public getExpirySecs() : int
Return values
int —

getExpiryTime()

Generated from protobuf field <code>.google.protobuf.Timestamp expiry_time = 5;</code>

public getExpiryTime() : Timestamp|null
Return values
Timestamp|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 —

hasExpirySecs()

public hasExpirySecs() : mixed
Return values
mixed —

hasExpiryTime()

public hasExpiryTime() : 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 —

setExpirySecs()

Generated from protobuf field <code>uint32 expiry_secs = 6;</code>

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

setExpiryTime()

Generated from protobuf field <code>.google.protobuf.Timestamp expiry_time = 5;</code>

public setExpiryTime(Timestamp $var) : $this
Parameters
$var : Timestamp
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 — 

        

        
    




    

    

                

    

        

            
Search results