Firestore in Datastore mode V1 API - Class Google::Cloud::Datastore::V1::CommitRequest (v0.17.0)

Version 0.17.0

• 1.2.0 (latest)
• 1.1.0
• 1.0.1
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.3
• 0.15.0
• 0.14.0
• 0.13.1
• 0.12.0
• 0.11.1
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.5

Reference documentation and code samples for the Firestore in Datastore mode V1 API class Google::Cloud::Datastore::V1::CommitRequest.

The request for Datastore.Commit.

Inherits

• Object

Extended By

• Google::Protobuf::MessageExts::ClassMethods

Includes

• Google::Protobuf::MessageExts

Methods

#database_id

def database_id() -> ::String

Returns

• (::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.

#database_id=

def database_id=(value) -> ::String

Parameter

• value (::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.

Returns

• (::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

def mode() -> ::Google::Cloud::Datastore::V1::CommitRequest::Mode

Returns

• (::Google::Cloud::Datastore::V1::CommitRequest::Mode) — The type of commit to perform. Defaults to TRANSACTIONAL.

#mode=

def mode=(value) -> ::Google::Cloud::Datastore::V1::CommitRequest::Mode

Parameter

• value (::Google::Cloud::Datastore::V1::CommitRequest::Mode) — The type of commit to perform. Defaults to TRANSACTIONAL.

Returns

• (::Google::Cloud::Datastore::V1::CommitRequest::Mode) — The type of commit to perform. Defaults to TRANSACTIONAL.

#mutations

def mutations() -> ::Array<::Google::Cloud::Datastore::V1::Mutation>

Returns

• (::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.

#mutations=

def mutations=(value) -> ::Array<::Google::Cloud::Datastore::V1::Mutation>

Parameter

• value (::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.

Returns

• (::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.

#project_id

def project_id() -> ::String

Returns

• (::String) — Required. The ID of the project against which to make the request.

#project_id=

def project_id=(value) -> ::String

Parameter

• value (::String) — Required. The ID of the project against which to make the request.

Returns

• (::String) — Required. The ID of the project against which to make the request.

#single_use_transaction

def single_use_transaction() -> ::Google::Cloud::Datastore::V1::TransactionOptions

Returns

• (::Google::Cloud::Datastore::V1::TransactionOptions) — Options for beginning a new transaction for this request. The transaction is committed when the request completes. If specified, TransactionOptions.mode must be TransactionOptions.ReadWrite.

#single_use_transaction=

def single_use_transaction=(value) -> ::Google::Cloud::Datastore::V1::TransactionOptions

Parameter

• value (::Google::Cloud::Datastore::V1::TransactionOptions) — Options for beginning a new transaction for this request. The transaction is committed when the request completes. If specified, TransactionOptions.mode must be TransactionOptions.ReadWrite.

Returns

• (::Google::Cloud::Datastore::V1::TransactionOptions) — Options for beginning a new transaction for this request. The transaction is committed when the request completes. If specified, TransactionOptions.mode must be TransactionOptions.ReadWrite.

#transaction

def transaction() -> ::String

Returns

• (::String) — The identifier of the transaction associated with the commit. A transaction identifier is returned by a call to Datastore.BeginTransaction.

#transaction=

def transaction=(value) -> ::String

Parameter

• value (::String) — The identifier of the transaction associated with the commit. A transaction identifier is returned by a call to Datastore.BeginTransaction.

Returns

• (::String) — The identifier of the transaction associated with the commit. A transaction identifier is returned by a call to Datastore.BeginTransaction.