Cloud Bigtable V2 Client - Class MutateRowRequest (2.15.0)

Version latest

• 2.15.0 (latest)
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.1
• 2.9.1
• 2.8.0
• 2.7.0
• 2.6.3
• 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 MutateRowRequest.

Request message for Bigtable.MutateRow.

Generated from protobuf message google.bigtable.v2.MutateRowRequest

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 mutation 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 mutation 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 mutation should be applied.
↳ mutations	array<Mutation> Required. Changes to be atomically applied to the specified row. Entries are applied in order, meaning that earlier mutations can be masked by later ones. Must contain at least one entry and at most 100000.
↳ idempotency	Idempotency Optional parameter for ensuring a MutateRow request is only applied once. Currently applicable only for certain aggregate types.

getTableName

Optional. The unique name of the table to which the mutation 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 mutation 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 mutation 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 mutation 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 mutation should be applied.

Returns
Type	Description
string

setRowKey

Required. The key of the row to which the mutation should be applied.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getMutations

Required. Changes to be atomically applied to the specified row. Entries are applied in order, meaning that earlier mutations can be masked by later ones. Must contain at least one entry and at most 100000.

Returns
Type	Description
Google\Protobuf\Internal\RepeatedField

setMutations

Required. Changes to be atomically applied to the specified row. Entries are applied in order, meaning that earlier mutations can be masked by later ones. Must contain at least one entry and at most 100000.

Parameter
Name	Description
var	array<Mutation>

Returns
Type	Description
$this

getIdempotency

Optional parameter for ensuring a MutateRow request is only applied once.

Currently applicable only for certain aggregate types.

Returns
Type	Description
Idempotency|null

hasIdempotency

clearIdempotency

setIdempotency

Optional parameter for ensuring a MutateRow request is only applied once.

Currently applicable only for certain aggregate types.

Parameter
Name	Description
var	Idempotency

Returns
Type	Description
$this

static::build

Parameters
Name	Description
tableName	string Optional. The unique name of the table to which the mutation 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 mutation should be applied.
mutations	array<Mutation> Required. Changes to be atomically applied to the specified row. Entries are applied in order, meaning that earlier mutations can be masked by later ones. Must contain at least one entry and at most 100000.

Returns
Type	Description
MutateRowRequest

static::buildFromTableNameRowKeyMutationsAppProfileId

Parameters
Name	Description
tableName	string Optional. The unique name of the table to which the mutation 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 mutation should be applied.
mutations	array<Mutation> Required. Changes to be atomically applied to the specified row. Entries are applied in order, meaning that earlier mutations can be masked by later ones. Must contain at least one entry and at most 100000.
appProfileId	string This value specifies routing for replication. If not specified, the "default" application profile will be used.

Returns
Type	Description
MutateRowRequest