Cloud Bigtable V2 Client - Class ReadModifyWriteRowRequest (2.8.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
dataarray

Optional. Data for populating the Message object.

↳ table_namestring

Optional. 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>.

↳ authorized_view_namestring

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

↳ app_profile_idstring

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

↳ row_keystring

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

↳ rulesarray<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

Optional. 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

Optional. 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
varstring
Returns
TypeDescription
$this

getAuthorizedViewName

Optional. The unique name of the AuthorizedView to which the read/modify/write rules should be applied.

Values are of the form projects/<project>/instances/<instance>/tables/<table>/authorizedViews/<authorized_view>.

Returns
TypeDescription
string

setAuthorizedViewName

Optional. The unique name of the AuthorizedView to which the read/modify/write rules should be applied.

Values are of the form projects/<project>/instances/<instance>/tables/<table>/authorizedViews/<authorized_view>.

Parameter
NameDescription
varstring
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
varstring
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
varstring
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
vararray<ReadModifyWriteRule>
Returns
TypeDescription
$this

static::build

Parameters
NameDescription
tableNamestring

Optional. 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 BigtableClient::tableName() for help formatting this field.

rowKeystring

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

rulesarray<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
ReadModifyWriteRowRequest

static::buildFromTableNameRowKeyRulesAppProfileId

Parameters
NameDescription
tableNamestring

Optional. 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 BigtableClient::tableName() for help formatting this field.

rowKeystring

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

rulesarray<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.

appProfileIdstring

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

Returns
TypeDescription
ReadModifyWriteRowRequest