Cloud Bigtable V2 Client - Class ReadModifyWriteRowRequest (2.17.1)

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. At least one entry must be specified, and there can be at most 100000 rules.

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. At least one entry must be specified, and there can be at most 100000 rules.

Returns
Type
Description

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. At least one entry must be specified, and there can be at most 100000 rules.

Parameter
Name
Description
var
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. At least one entry must be specified, and there can be at most 100000 rules.

Returns
Type
Description

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. At least one entry must be specified, and there can be at most 100000 rules.

appProfileId
string

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

Returns
Type
Description
Create a Mobile Website
View Site in Mobile | Classic
Share by: