Cloud Bigtable V2 Client - Class ReadModifyWriteRowRequest (1.25.0)

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

Request message for Bigtable.ReadModifyWriteRow.

Generated from protobuf message google.bigtable.v2.ReadModifyWriteRowRequest

Namespace

Google \ Cloud \ Bigtable \ V2

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ table_name string

Required. The unique name of the table to which the read/modify/write rules should be applied. Values are of the form projects/<project>/instances/<instance>/tables/<table>.

↳ app_profile_id string

This value specifies routing for replication. If not specified, the "default" application profile will be used.

↳ row_key string

Required. The key of the row to which the read/modify/write rules should be applied.

↳ rules array<Google\Cloud\Bigtable\V2\ReadModifyWriteRule>

Required. Rules specifying how the specified row's contents are to be transformed into writes. Entries are applied in order, meaning that earlier rules will affect the results of later ones.

getTableName

Required. The unique name of the table to which the read/modify/write rules should be applied. Values are of the form projects/<project>/instances/<instance>/tables/<table>.

Returns
TypeDescription
string

setTableName

Required. The unique name of the table to which the read/modify/write rules should be applied. Values are of the form projects/<project>/instances/<instance>/tables/<table>.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getAppProfileId

This value specifies routing for replication. If not specified, the "default" application profile will be used.

Returns
TypeDescription
string

setAppProfileId

This value specifies routing for replication. If not specified, the "default" application profile will be used.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getRowKey

Required. The key of the row to which the read/modify/write rules should be applied.

Returns
TypeDescription
string

setRowKey

Required. The key of the row to which the read/modify/write rules should be applied.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getRules

Required. Rules specifying how the specified row's contents are to be transformed into writes. Entries are applied in order, meaning that earlier rules will affect the results of later ones.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setRules

Required. Rules specifying how the specified row's contents are to be transformed into writes. Entries are applied in order, meaning that earlier rules will affect the results of later ones.

Parameter
NameDescription
var array<Google\Cloud\Bigtable\V2\ReadModifyWriteRule>
Returns
TypeDescription
$this

static::build

Parameters
NameDescription
tableName string

Required. The unique name of the table to which the read/modify/write rules should be applied. Values are of the form projects/<project>/instances/<instance>/tables/<table>. Please see Google\Cloud\Bigtable\V2\BigtableClient::tableName() for help formatting this field.

rowKey string

Required. The key of the row to which the read/modify/write rules should be applied.

rules array<Google\Cloud\Bigtable\V2\ReadModifyWriteRule>

Required. Rules specifying how the specified row's contents are to be transformed into writes. Entries are applied in order, meaning that earlier rules will affect the results of later ones.

Returns
TypeDescription
Google\Cloud\Bigtable\V2\ReadModifyWriteRowRequest

static::buildFromTableNameRowKeyRulesAppProfileId

Parameters
NameDescription
tableName string

Required. The unique name of the table to which the read/modify/write rules should be applied. Values are of the form projects/<project>/instances/<instance>/tables/<table>. Please see Google\Cloud\Bigtable\V2\BigtableClient::tableName() for help formatting this field.

rowKey string

Required. The key of the row to which the read/modify/write rules should be applied.

rules array<Google\Cloud\Bigtable\V2\ReadModifyWriteRule>

Required. Rules specifying how the specified row's contents are to be transformed into writes. Entries are applied in order, meaning that earlier rules will affect the results of later ones.

appProfileId string

This value specifies routing for replication. If not specified, the "default" application profile will be used.

Returns
TypeDescription
Google\Cloud\Bigtable\V2\ReadModifyWriteRowRequest