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 messagegoogle.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 thatappend_valuebe 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 thatincrement_amountbe 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 thatappend_valuebe 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 thatappend_valuebe 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 thatincrement_amountbe 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 thatincrement_amountbe 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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Cloud Bigtable V2 Client - Class ReadModifyWriteRule (2.17.1)\n\nVersion latestkeyboard_arrow_down\n\n- [2.17.1 (latest)](/php/docs/reference/cloud-bigtable/latest/V2.ReadModifyWriteRule)\n- [2.17.0](/php/docs/reference/cloud-bigtable/2.17.0/V2.ReadModifyWriteRule)\n- [2.16.0](/php/docs/reference/cloud-bigtable/2.16.0/V2.ReadModifyWriteRule)\n- [2.15.0](/php/docs/reference/cloud-bigtable/2.15.0/V2.ReadModifyWriteRule)\n- [2.14.0](/php/docs/reference/cloud-bigtable/2.14.0/V2.ReadModifyWriteRule)\n- [2.13.0](/php/docs/reference/cloud-bigtable/2.13.0/V2.ReadModifyWriteRule)\n- [2.12.0](/php/docs/reference/cloud-bigtable/2.12.0/V2.ReadModifyWriteRule)\n- [2.11.1](/php/docs/reference/cloud-bigtable/2.11.1/V2.ReadModifyWriteRule)\n- [2.9.1](/php/docs/reference/cloud-bigtable/2.9.1/V2.ReadModifyWriteRule)\n- [2.8.0](/php/docs/reference/cloud-bigtable/2.8.0/V2.ReadModifyWriteRule)\n- [2.7.0](/php/docs/reference/cloud-bigtable/2.7.0/V2.ReadModifyWriteRule)\n- [2.6.3](/php/docs/reference/cloud-bigtable/2.6.3/V2.ReadModifyWriteRule)\n- [2.5.0](/php/docs/reference/cloud-bigtable/2.5.0/V2.ReadModifyWriteRule)\n- [2.4.0](/php/docs/reference/cloud-bigtable/2.4.0/V2.ReadModifyWriteRule)\n- [2.3.0](/php/docs/reference/cloud-bigtable/2.3.0/V2.ReadModifyWriteRule)\n- [2.2.1](/php/docs/reference/cloud-bigtable/2.2.1/V2.ReadModifyWriteRule)\n- [2.1.0](/php/docs/reference/cloud-bigtable/2.1.0/V2.ReadModifyWriteRule)\n- [2.0.1](/php/docs/reference/cloud-bigtable/2.0.1/V2.ReadModifyWriteRule)\n- [1.32.1](/php/docs/reference/cloud-bigtable/1.32.1/V2.ReadModifyWriteRule)\n- [1.31.1](/php/docs/reference/cloud-bigtable/1.31.1/V2.ReadModifyWriteRule)\n- [1.30.0](/php/docs/reference/cloud-bigtable/1.30.0/V2.ReadModifyWriteRule)\n- [1.29.2](/php/docs/reference/cloud-bigtable/1.29.2/V2.ReadModifyWriteRule)\n- [1.28.3](/php/docs/reference/cloud-bigtable/1.28.3/V2.ReadModifyWriteRule)\n- [1.27.0](/php/docs/reference/cloud-bigtable/1.27.0/V2.ReadModifyWriteRule)\n- [1.26.2](/php/docs/reference/cloud-bigtable/1.26.2/V2.ReadModifyWriteRule)\n- [1.25.0](/php/docs/reference/cloud-bigtable/1.25.0/V2.ReadModifyWriteRule)\n- [1.24.1](/php/docs/reference/cloud-bigtable/1.24.1/V2.ReadModifyWriteRule)\n- [1.23.0](/php/docs/reference/cloud-bigtable/1.23.0/V2.ReadModifyWriteRule)\n- [1.22.2](/php/docs/reference/cloud-bigtable/1.22.2/V2.ReadModifyWriteRule)\n- [1.21.1](/php/docs/reference/cloud-bigtable/1.21.1/V2.ReadModifyWriteRule)\n- [1.20.3](/php/docs/reference/cloud-bigtable/1.20.3/V2.ReadModifyWriteRule) \nReference documentation and code samples for the Cloud Bigtable V2 Client class ReadModifyWriteRule.\n\nSpecifies an atomic read/modify/write operation on the latest value of the\nspecified column.\n\nGenerated from protobuf message `google.bigtable.v2.ReadModifyWriteRule`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Bigtable \\\\ V2\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getFamilyName\n\nThe name of the family to which the read/modify/write should be applied.\n\nMust match `[-_.a-zA-Z0-9]+`\n\n### setFamilyName\n\nThe name of the family to which the read/modify/write should be applied.\n\nMust match `[-_.a-zA-Z0-9]+`\n\n### getColumnQualifier\n\nThe qualifier of the column to which the read/modify/write should be\napplied.\n\nCan be any byte string, including the empty string.\n\n### setColumnQualifier\n\nThe qualifier of the column to which the read/modify/write should be\napplied.\n\nCan be any byte string, including the empty string.\n\n### getAppendValue\n\nRule specifying that `append_value` be appended to the existing value.\n\nIf the targeted cell is unset, it will be treated as containing the\nempty string.\n\n### hasAppendValue\n\n### setAppendValue\n\nRule specifying that `append_value` be appended to the existing value.\n\nIf the targeted cell is unset, it will be treated as containing the\nempty string.\n\n### getIncrementAmount\n\nRule specifying that `increment_amount` be added to the existing value.\n\nIf the targeted cell is unset, it will be treated as containing a zero.\nOtherwise, the targeted cell must contain an 8-byte value (interpreted\nas a 64-bit big-endian signed integer), or the entire request will fail.\n\n### hasIncrementAmount\n\n### setIncrementAmount\n\nRule specifying that `increment_amount` be added to the existing value.\n\nIf the targeted cell is unset, it will be treated as containing a zero.\nOtherwise, the targeted cell must contain an 8-byte value (interpreted\nas a 64-bit big-endian signed integer), or the entire request will fail.\n\n### getRule"]]
