Cloud Bigtable V2 Client - Class MutateRowRequest (2.16.0)

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

If set consistently across retries, prevents this mutation from being double applied to aggregate column families within a 15m window.

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

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

If set consistently across retries, prevents this mutation from being double applied to aggregate column families within a 15m window.

Returns
Type
Description
Idempotency |null

hasIdempotency

clearIdempotency

setIdempotency

If set consistently across retries, prevents this mutation from being double applied to aggregate column families within a 15m window.

Parameter
Name
Description
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

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
Create a Mobile Website
View Site in Mobile | Classic
Share by: