Cloud Bigtable V2 Client - Class MutateRowsRequest (1.32.1)

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
Name Description
data array

Optional. Data for populating the Message object.

↳ table_name string

Optional. The unique name of the table to which the mutations 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 mutations 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.

↳ 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

Optional. The unique name of the table to which the mutations 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 mutations 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 mutations 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 mutations 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

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
Type Description
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
Name Description
var array<Google\Cloud\Bigtable\V2\MutateRowsRequest\Entry>
Returns
Type Description
$this

static::build

Parameters
Name Description
tableName string

Optional. The unique name of the table to which the mutations 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.

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
Type Description
Google\Cloud\Bigtable\V2\MutateRowsRequest

static::buildFromTableNameEntriesAppProfileId

Parameters
Name Description
tableName string

Optional. The unique name of the table to which the mutations 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.

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
Type Description
Google\Cloud\Bigtable\V2\MutateRowsRequest