Cloud Bigtable V2 Client - Class ReadModifyWriteRule (1.31.1)

Reference documentation and code samples for the Cloud Bigtable V2 Client class ReadModifyWriteRule.

Specifies an atomic read/modify/write operation on the latest value of the specified column.

Generated from protobuf message google.bigtable.v2.ReadModifyWriteRule

Namespace

Google \ Cloud \ Bigtable \ V2

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ family_name string

The name of the family to which the read/modify/write should be applied. Must match [-_.a-zA-Z0-9]+
↳ column_qualifier string

The qualifier of the column to which the read/modify/write should be applied. Can be any byte string, including the empty string.
↳ append_value string

Rule specifying that append_value be appended to the existing value. If the targeted cell is unset, it will be treated as containing the empty string.
↳ increment_amount int|string

Rule specifying that increment_amount be added to the existing value. If the targeted cell is unset, it will be treated as containing a zero. Otherwise, the targeted cell must contain an 8-byte value (interpreted as a 64-bit big-endian signed integer), or the entire request will fail.

getFamilyName

The name of the family to which the read/modify/write should be applied.

Must match [-_.a-zA-Z0-9]+

Returns
Type Description
string

setFamilyName

The name of the family to which the read/modify/write should be applied.

Must match [-_.a-zA-Z0-9]+

Parameter
Name Description
var string
Returns
Type Description
$this

getColumnQualifier

The qualifier of the column to which the read/modify/write should be applied.

Can be any byte string, including the empty string.

Returns
Type Description
string

setColumnQualifier

The qualifier of the column to which the read/modify/write should be applied.

Can be any byte string, including the empty string.

Parameter
Name Description
var string
Returns
Type Description
$this

getAppendValue

Rule specifying that append_value be appended to the existing value.

If the targeted cell is unset, it will be treated as containing the empty string.

Returns
Type Description
string

hasAppendValue

setAppendValue

Rule specifying that append_value be appended to the existing value.

If the targeted cell is unset, it will be treated as containing the empty string.

Parameter
Name Description
var string
Returns
Type Description
$this

getIncrementAmount

Rule specifying that increment_amount be added to the existing value.

If the targeted cell is unset, it will be treated as containing a zero. Otherwise, the targeted cell must contain an 8-byte value (interpreted as a 64-bit big-endian signed integer), or the entire request will fail.

Returns
Type Description
int|string

hasIncrementAmount

setIncrementAmount

Rule specifying that increment_amount be added to the existing value.

If the targeted cell is unset, it will be treated as containing a zero. Otherwise, the targeted cell must contain an 8-byte value (interpreted as a 64-bit big-endian signed integer), or the entire request will fail.

Parameter
Name Description
var int|string
Returns
Type Description
$this

getRule

Returns
Type Description
string