Cloud Datastore V1 Client - Class CommitRequest (1.17.1)

Reference documentation and code samples for the Cloud Datastore V1 Client class CommitRequest.

The request for Datastore.Commit.

Generated from protobuf message google.datastore.v1.CommitRequest

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ project_id string

Required. The ID of the project against which to make the request.

↳ database_id string

The ID of the database against which to make the request. '(default)' is not allowed; please use empty string '' to refer the default database.

↳ mode int

The type of commit to perform. Defaults to TRANSACTIONAL.

↳ transaction string

The identifier of the transaction associated with the commit. A transaction identifier is returned by a call to Datastore.BeginTransaction.

↳ mutations array<Google\Cloud\Datastore\V1\Mutation>

The mutations to perform. When mode is TRANSACTIONAL, mutations affecting a single entity are applied in order. The following sequences of mutations affecting a single entity are not permitted in a single Commit request: - insert followed by insert - update followed by insert - upsert followed by insert - delete followed by update When mode is NON_TRANSACTIONAL, no two mutations may affect a single entity.

getProjectId

Required. The ID of the project against which to make the request.

Generated from protobuf field string project_id = 8 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
string

setProjectId

Required. The ID of the project against which to make the request.

Generated from protobuf field string project_id = 8 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getDatabaseId

The ID of the database against which to make the request.

'(default)' is not allowed; please use empty string '' to refer the default database.

Generated from protobuf field string database_id = 9;

Returns
TypeDescription
string

setDatabaseId

The ID of the database against which to make the request.

'(default)' is not allowed; please use empty string '' to refer the default database.

Generated from protobuf field string database_id = 9;

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getMode

The type of commit to perform. Defaults to TRANSACTIONAL.

Generated from protobuf field .google.datastore.v1.CommitRequest.Mode mode = 5;

Returns
TypeDescription
int

setMode

The type of commit to perform. Defaults to TRANSACTIONAL.

Generated from protobuf field .google.datastore.v1.CommitRequest.Mode mode = 5;

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getTransaction

The identifier of the transaction associated with the commit. A transaction identifier is returned by a call to Datastore.BeginTransaction.

Generated from protobuf field bytes transaction = 1;

Returns
TypeDescription
string

hasTransaction

setTransaction

The identifier of the transaction associated with the commit. A transaction identifier is returned by a call to Datastore.BeginTransaction.

Generated from protobuf field bytes transaction = 1;

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getMutations

The mutations to perform.

When mode is TRANSACTIONAL, mutations affecting a single entity are applied in order. The following sequences of mutations affecting a single entity are not permitted in a single Commit request:

  • insert followed by insert
  • update followed by insert
  • upsert followed by insert
  • delete followed by update When mode is NON_TRANSACTIONAL, no two mutations may affect a single entity.

Generated from protobuf field repeated .google.datastore.v1.Mutation mutations = 6;

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setMutations

The mutations to perform.

When mode is TRANSACTIONAL, mutations affecting a single entity are applied in order. The following sequences of mutations affecting a single entity are not permitted in a single Commit request:

  • insert followed by insert
  • update followed by insert
  • upsert followed by insert
  • delete followed by update When mode is NON_TRANSACTIONAL, no two mutations may affect a single entity.

Generated from protobuf field repeated .google.datastore.v1.Mutation mutations = 6;

Parameter
NameDescription
var array<Google\Cloud\Datastore\V1\Mutation>
Returns
TypeDescription
$this

getTransactionSelector

Returns
TypeDescription
string