Cloud Bigtable V2 Client - Class MutateRowsRequest (1.27.0)

Reference documentation and code samples for the Cloud Bigtable V2 Client class MutateRowsRequest.

Request message for BigtableService.MutateRows.

Generated from protobuf message google.bigtable.v2.MutateRowsRequest

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 mutations should be applied.

↳ app_profile_id string

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

↳ entries array<Google\Cloud\Bigtable\V2\MutateRowsRequest\Entry>

Required. The row keys and corresponding mutations to be applied in bulk. Each entry is applied as an atomic mutation, but the entries may be applied in arbitrary order (even between entries for the same row). At least one entry must be specified, and in total the entries can contain at most 100000 mutations.

getTableName

Required. The unique name of the table to which the mutations should be applied.

Returns
TypeDescription
string

setTableName

Required. The unique name of the table to which the mutations should be applied.

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

getEntries

Required. The row keys and corresponding mutations to be applied in bulk.

Each entry is applied as an atomic mutation, but the entries may be applied in arbitrary order (even between entries for the same row). At least one entry must be specified, and in total the entries can contain at most 100000 mutations.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setEntries

Required. The row keys and corresponding mutations to be applied in bulk.

Each entry is applied as an atomic mutation, but the entries may be applied in arbitrary order (even between entries for the same row). At least one entry must be specified, and in total the entries can contain at most 100000 mutations.

Parameter
NameDescription
var array<Google\Cloud\Bigtable\V2\MutateRowsRequest\Entry>
Returns
TypeDescription
$this

static::build

Parameters
NameDescription
tableName string

Required. The unique name of the table to which the mutations should be applied. Please see Google\Cloud\Bigtable\V2\BigtableClient::tableName() for help formatting this field.

entries array<Google\Cloud\Bigtable\V2\MutateRowsRequest\Entry>

Required. The row keys and corresponding mutations to be applied in bulk. Each entry is applied as an atomic mutation, but the entries may be applied in arbitrary order (even between entries for the same row). At least one entry must be specified, and in total the entries can contain at most 100000 mutations.

Returns
TypeDescription
Google\Cloud\Bigtable\V2\MutateRowsRequest

static::buildFromTableNameEntriesAppProfileId

Parameters
NameDescription
tableName string

Required. The unique name of the table to which the mutations should be applied. Please see Google\Cloud\Bigtable\V2\BigtableClient::tableName() for help formatting this field.

entries array<Google\Cloud\Bigtable\V2\MutateRowsRequest\Entry>

Required. The row keys and corresponding mutations to be applied in bulk. Each entry is applied as an atomic mutation, but the entries may be applied in arbitrary order (even between entries for the same row). At least one entry must be specified, and in total the entries can contain at most 100000 mutations.

appProfileId string

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

Returns
TypeDescription
Google\Cloud\Bigtable\V2\MutateRowsRequest