Documentation

MutateInRequest extends Message
in package

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

Table of Contents

$bucket_name  : mixed
Generated from protobuf field <code>string bucket_name = 1;</code>
$cas  : mixed
Generated from protobuf field <code>optional uint64 cas = 9;</code>
$collection_name  : mixed
Generated from protobuf field <code>string collection_name = 3;</code>
$durability_level  : mixed
Generated from protobuf field <code>optional .couchbase.kv.v1.DurabilityLevel durability_level = 8;</code>
$expiry  : mixed
$flags  : mixed
Generated from protobuf field <code>optional .couchbase.kv.v1.MutateInRequest.Flags flags = 10;</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>
$store_semantic  : mixed
Generated from protobuf field <code>optional .couchbase.kv.v1.MutateInRequest.StoreSemantic store_semantic = 6;</code>
$specs  : mixed
Generated from protobuf field <code>repeated .couchbase.kv.v1.MutateInRequest.Spec specs = 5;</code>
__construct()  : mixed
Constructor.
clearCas()  : mixed
clearDurabilityLevel()  : mixed
clearFlags()  : mixed
clearStoreSemantic()  : mixed
getBucketName()  : string
Generated from protobuf field <code>string bucket_name = 1;</code>
getCas()  : int|string
Generated from protobuf field <code>optional uint64 cas = 9;</code>
getCollectionName()  : string
Generated from protobuf field <code>string collection_name = 3;</code>
getDurabilityLevel()  : int
Generated from protobuf field <code>optional .couchbase.kv.v1.DurabilityLevel durability_level = 8;</code>
getExpiry()  : string
getExpirySecs()  : int
Generated from protobuf field <code>uint32 expiry_secs = 12;</code>
getExpiryTime()  : Timestamp|null
Generated from protobuf field <code>.google.protobuf.Timestamp expiry_time = 11;</code>
getFlags()  : Flags|null
Generated from protobuf field <code>optional .couchbase.kv.v1.MutateInRequest.Flags flags = 10;</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.MutateInRequest.Spec specs = 5;</code>
getStoreSemantic()  : int
Generated from protobuf field <code>optional .couchbase.kv.v1.MutateInRequest.StoreSemantic store_semantic = 6;</code>
hasCas()  : mixed
hasDurabilityLevel()  : mixed
hasExpirySecs()  : mixed
hasExpiryTime()  : mixed
hasFlags()  : mixed
hasStoreSemantic()  : mixed
setBucketName()  : $this
Generated from protobuf field <code>string bucket_name = 1;</code>
setCas()  : $this
Generated from protobuf field <code>optional uint64 cas = 9;</code>
setCollectionName()  : $this
Generated from protobuf field <code>string collection_name = 3;</code>
setDurabilityLevel()  : $this
Generated from protobuf field <code>optional .couchbase.kv.v1.DurabilityLevel durability_level = 8;</code>
setExpirySecs()  : $this
Generated from protobuf field <code>uint32 expiry_secs = 12;</code>
setExpiryTime()  : $this
Generated from protobuf field <code>.google.protobuf.Timestamp expiry_time = 11;</code>
setFlags()  : $this
Generated from protobuf field <code>optional .couchbase.kv.v1.MutateInRequest.Flags flags = 10;</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.MutateInRequest.Spec specs = 5;</code>
setStoreSemantic()  : $this
Generated from protobuf field <code>optional .couchbase.kv.v1.MutateInRequest.StoreSemantic store_semantic = 6;</code>

Properties

$bucket_name

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

protected mixed $bucket_name = ''

$cas

Generated from protobuf field <code>optional uint64 cas = 9;</code>

protected mixed $cas = null

$collection_name

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

protected mixed $collection_name = ''

$durability_level

Generated from protobuf field <code>optional .couchbase.kv.v1.DurabilityLevel durability_level = 8;</code>

protected mixed $durability_level = null

$flags

Generated from protobuf field <code>optional .couchbase.kv.v1.MutateInRequest.Flags flags = 10;</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 = ''

$store_semantic

Generated from protobuf field <code>optional .couchbase.kv.v1.MutateInRequest.StoreSemantic store_semantic = 6;</code>

protected mixed $store_semantic = null

$specs

Generated from protobuf field <code>repeated .couchbase.kv.v1.MutateInRequest.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\MutateInRequest\Spec>|\Google\Protobuf\Internal\RepeatedField $specs
@type int $store_semantic
@type int $durability_level
@type int|string $cas
@type \Couchbase\Protostellar\Generated\KV\V1\MutateInRequest\Flags $flags
@type \Google\Protobuf\Timestamp $expiry_time
@type int $expiry_secs

}

Return values
mixed —

clearDurabilityLevel()

public clearDurabilityLevel() : mixed
Return values
mixed —

clearStoreSemantic()

public clearStoreSemantic() : mixed
Return values
mixed —

getBucketName()

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

public getBucketName() : string
Return values
string —

getCas()

Generated from protobuf field <code>optional uint64 cas = 9;</code>

public getCas() : int|string
Return values
int|string —

getCollectionName()

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

public getCollectionName() : string
Return values
string —

getDurabilityLevel()

Generated from protobuf field <code>optional .couchbase.kv.v1.DurabilityLevel durability_level = 8;</code>

public getDurabilityLevel() : int
Return values
int —

getExpirySecs()

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

public getExpirySecs() : int
Return values
int —

getExpiryTime()

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

public getExpiryTime() : Timestamp|null
Return values
Timestamp|null —

getFlags()

Generated from protobuf field <code>optional .couchbase.kv.v1.MutateInRequest.Flags flags = 10;</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.MutateInRequest.Spec specs = 5;</code>

public getSpecs() : RepeatedField
Return values
RepeatedField —

getStoreSemantic()

Generated from protobuf field <code>optional .couchbase.kv.v1.MutateInRequest.StoreSemantic store_semantic = 6;</code>

public getStoreSemantic() : int
Return values
int —

hasDurabilityLevel()

public hasDurabilityLevel() : mixed
Return values
mixed —

hasExpirySecs()

public hasExpirySecs() : mixed
Return values
mixed —

hasExpiryTime()

public hasExpiryTime() : mixed
Return values
mixed —

hasStoreSemantic()

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

setCas()

Generated from protobuf field <code>optional uint64 cas = 9;</code>

public setCas(int|string $var) : $this
Parameters
$var : int|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 —

setDurabilityLevel()

Generated from protobuf field <code>optional .couchbase.kv.v1.DurabilityLevel durability_level = 8;</code>

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

setExpirySecs()

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

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

setExpiryTime()

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

public setExpiryTime(Timestamp $var) : $this
Parameters
$var : Timestamp
Return values
$this —

setFlags()

Generated from protobuf field <code>optional .couchbase.kv.v1.MutateInRequest.Flags flags = 10;</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.MutateInRequest.Spec specs = 5;</code>

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

setStoreSemantic()

Generated from protobuf field <code>optional .couchbase.kv.v1.MutateInRequest.StoreSemantic store_semantic = 6;</code>

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

        

        
    




    

    

                

    

        

            
Search results