Class: Google::Apis::FirestoreV1::CommitRequest

Inherits:

Object

• Object
• Google::Apis::FirestoreV1::CommitRequest

Includes:

Core::Hashable, Core::JsonObjectSupport

Defined in:

generated/google/apis/firestore_v1/classes.rb,
generated/google/apis/firestore_v1/representations.rb,
generated/google/apis/firestore_v1/representations.rb

Overview

The request for Firestore.Commit.

Instance Attribute Summary

• #transaction ⇒ String

  If set, applies all writes in this transaction, and commits it.

• #writes ⇒ Array<Google::Apis::FirestoreV1::Write>

  The writes to apply.

Instance Method Summary

• #initialize(**args) ⇒ CommitRequest constructor

  A new instance of CommitRequest.

• #update!(**args) ⇒ Object

  Update properties of this object.

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ CommitRequest

Returns a new instance of CommitRequest

# File 'generated/google/apis/firestore_v1/classes.rb', line 225

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#transaction ⇒ String

If set, applies all writes in this transaction, and commits it. Corresponds to the JSON property transaction NOTE: Values are automatically base64 encoded/decoded in the client library.

Returns:

• (String)

# File 'generated/google/apis/firestore_v1/classes.rb', line 217

def transaction
  @transaction
end

#writes ⇒ Array<Google::Apis::FirestoreV1::Write>

The writes to apply. Always executed atomically and in order. Corresponds to the JSON property writes

Returns:

• (Array<Google::Apis::FirestoreV1::Write>)

# File 'generated/google/apis/firestore_v1/classes.rb', line 223

def writes
  @writes
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

# File 'generated/google/apis/firestore_v1/classes.rb', line 230

def update!(**args)
  @transaction = args[:transaction] if args.key?(:transaction)
  @writes = args[:writes] if args.key?(:writes)
end