Documentation

UpsertRequest extends Message
in package

Generated from protobuf message <code>couchbase.kv.v1.UpsertRequest</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>
$content  : mixed
$content_flags  : mixed
Generated from protobuf field <code>uint32 content_flags = 11;</code>
$durability_level  : mixed
Generated from protobuf field <code>optional .couchbase.kv.v1.DurabilityLevel durability_level = 9;</code>
$expiry  : mixed
$key  : mixed
Generated from protobuf field <code>string key = 4;</code>
$preserve_expiry_on_existing  : mixed
Generated from protobuf field <code>optional bool preserve_expiry_on_existing = 12;</code>
$scope_name  : mixed
Generated from protobuf field <code>string scope_name = 2;</code>
__construct()  : mixed
Constructor.
clearDurabilityLevel()  : mixed
clearPreserveExpiryOnExisting()  : 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>
getContent()  : string
getContentCompressed()  : string
Generated from protobuf field <code>bytes content_compressed = 13;</code>
getContentFlags()  : int
Generated from protobuf field <code>uint32 content_flags = 11;</code>
getContentUncompressed()  : string
Generated from protobuf field <code>bytes content_uncompressed = 5;</code>
getDurabilityLevel()  : int
Generated from protobuf field <code>optional .couchbase.kv.v1.DurabilityLevel durability_level = 9;</code>
getExpiry()  : string
getExpirySecs()  : int
Generated from protobuf field <code>uint32 expiry_secs = 10;</code>
getExpiryTime()  : Timestamp|null
Generated from protobuf field <code>.google.protobuf.Timestamp expiry_time = 7;</code>
getKey()  : string
Generated from protobuf field <code>string key = 4;</code>
getPreserveExpiryOnExisting()  : bool
Generated from protobuf field <code>optional bool preserve_expiry_on_existing = 12;</code>
getScopeName()  : string
Generated from protobuf field <code>string scope_name = 2;</code>
hasContentCompressed()  : mixed
hasContentUncompressed()  : mixed
hasDurabilityLevel()  : mixed
hasExpirySecs()  : mixed
hasExpiryTime()  : mixed
hasPreserveExpiryOnExisting()  : 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>
setContentCompressed()  : $this
Generated from protobuf field <code>bytes content_compressed = 13;</code>
setContentFlags()  : $this
Generated from protobuf field <code>uint32 content_flags = 11;</code>
setContentUncompressed()  : $this
Generated from protobuf field <code>bytes content_uncompressed = 5;</code>
setDurabilityLevel()  : $this
Generated from protobuf field <code>optional .couchbase.kv.v1.DurabilityLevel durability_level = 9;</code>
setExpirySecs()  : $this
Generated from protobuf field <code>uint32 expiry_secs = 10;</code>
setExpiryTime()  : $this
Generated from protobuf field <code>.google.protobuf.Timestamp expiry_time = 7;</code>
setKey()  : $this
Generated from protobuf field <code>string key = 4;</code>
setPreserveExpiryOnExisting()  : $this
Generated from protobuf field <code>optional bool preserve_expiry_on_existing = 12;</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 = ''

$content_flags

Generated from protobuf field <code>uint32 content_flags = 11;</code>

protected mixed $content_flags = 0

$durability_level

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

protected mixed $durability_level = null

$key

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

protected mixed $key = ''

$preserve_expiry_on_existing

Generated from protobuf field <code>optional bool preserve_expiry_on_existing = 12;</code>

protected mixed $preserve_expiry_on_existing = null

$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 string $content_uncompressed
@type string $content_compressed
@type int $content_flags
@type \Google\Protobuf\Timestamp $expiry_time
@type int $expiry_secs
@type bool $preserve_expiry_on_existing
@type int $durability_level

}

Return values
mixed —

clearDurabilityLevel()

public clearDurabilityLevel() : mixed
Return values
mixed —

clearPreserveExpiryOnExisting()

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

getContent()

public getContent() : string
Return values
string —

getContentCompressed()

Generated from protobuf field <code>bytes content_compressed = 13;</code>

public getContentCompressed() : string
Return values
string —

getContentFlags()

Generated from protobuf field <code>uint32 content_flags = 11;</code>

public getContentFlags() : int
Return values
int —

getContentUncompressed()

Generated from protobuf field <code>bytes content_uncompressed = 5;</code>

public getContentUncompressed() : string
Return values
string —

getDurabilityLevel()

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

public getDurabilityLevel() : int
Return values
int —

getExpiry()

public getExpiry() : string
Return values
string —

getExpirySecs()

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

public getExpirySecs() : int
Return values
int —

getExpiryTime()

Generated from protobuf field <code>.google.protobuf.Timestamp expiry_time = 7;</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 —

getPreserveExpiryOnExisting()

Generated from protobuf field <code>optional bool preserve_expiry_on_existing = 12;</code>

public getPreserveExpiryOnExisting() : bool
Return values
bool —

getScopeName()

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

public getScopeName() : string
Return values
string —

hasContentCompressed()

public hasContentCompressed() : mixed
Return values
mixed —

hasContentUncompressed()

public hasContentUncompressed() : mixed
Return values
mixed —

hasDurabilityLevel()

public hasDurabilityLevel() : mixed
Return values
mixed —

hasExpirySecs()

public hasExpirySecs() : mixed
Return values
mixed —

hasExpiryTime()

public hasExpiryTime() : mixed
Return values
mixed —

hasPreserveExpiryOnExisting()

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

setContentCompressed()

Generated from protobuf field <code>bytes content_compressed = 13;</code>

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

setContentFlags()

Generated from protobuf field <code>uint32 content_flags = 11;</code>

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

setContentUncompressed()

Generated from protobuf field <code>bytes content_uncompressed = 5;</code>

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

setDurabilityLevel()

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

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

setExpirySecs()

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

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

setExpiryTime()

Generated from protobuf field <code>.google.protobuf.Timestamp expiry_time = 7;</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 —

setPreserveExpiryOnExisting()

Generated from protobuf field <code>optional bool preserve_expiry_on_existing = 12;</code>

public setPreserveExpiryOnExisting(bool $var) : $this
Parameters
$var : bool
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