Cloud Bigtable V2 Client - Class MutateRowRequest (1.24.1)

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
NameDescription
data array

Optional. Data for populating the Message object.

↳ table_name string

Required. The unique name of the table to which the mutation should be applied. Values are of the form projects/<project>/instances/<instance>/tables/<table>.

↳ 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<Google\Cloud\Bigtable\V2\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.

getTableName

Required. 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
TypeDescription
string

setTableName

Required. 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
NameDescription
var string
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
var string
Returns
TypeDescription
$this

getRowKey

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

Returns
TypeDescription
string

setRowKey

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

Parameter
NameDescription
var string
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var array<Google\Cloud\Bigtable\V2\Mutation>
Returns
TypeDescription
$this

static::build

Parameters
NameDescription
tableName string

Required. 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 Google\Cloud\Bigtable\V2\BigtableClient::tableName() for help formatting this field.

rowKey string

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

mutations array<Google\Cloud\Bigtable\V2\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
TypeDescription
Google\Cloud\Bigtable\V2\MutateRowRequest

static::buildFromTableNameRowKeyMutationsAppProfileId

Parameters
NameDescription
tableName string

Required. 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 Google\Cloud\Bigtable\V2\BigtableClient::tableName() for help formatting this field.

rowKey string

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

mutations array<Google\Cloud\Bigtable\V2\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
TypeDescription
Google\Cloud\Bigtable\V2\MutateRowRequest