Cloud Bigtable V2 Client - Class ReadModifyWriteRowRequest (2.6.1)

Version latest

• 2.6.1 (latest)
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.1
• 2.1.0
• 2.0.1
• 1.32.1
• 1.31.1
• 1.30.0
• 1.29.2
• 1.28.3
• 1.27.0
• 1.26.2
• 1.25.0
• 1.24.1
• 1.23.0
• 1.22.2
• 1.21.1
• 1.20.3

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
Name	Description
data	array Optional. Data for populating the Message object.
↳ table_name	string 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_name	string 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_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<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
Type	Description
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
Name	Description
var	string

Returns
Type	Description
$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
Type	Description
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
Name	Description
var	string

Returns
Type	Description
$this

getAppProfileId

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

Returns
Type	Description
string

setAppProfileId

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

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getRowKey

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

Returns
Type	Description
string

setRowKey

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

Parameter
Name	Description
var	string

Returns
Type	Description
$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
Type	Description
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
Name	Description
var	array<ReadModifyWriteRule>

Returns
Type	Description
$this

static::build

Parameters
Name	Description
tableName	string 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.
rowKey	string Required. The key of the row to which the read/modify/write rules should be applied.
rules	array<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
Type	Description
ReadModifyWriteRowRequest

static::buildFromTableNameRowKeyRulesAppProfileId

Parameters
Name	Description
tableName	string 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.
rowKey	string Required. The key of the row to which the read/modify/write rules should be applied.
rules	array<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
Type	Description
ReadModifyWriteRowRequest