Cloud Firestore API - Class Google::Cloud::Firestore::CommitResponse (v2.8.0)

Reference documentation and code samples for the Cloud Firestore API class Google::Cloud::Firestore::CommitResponse.

CommitResponse

The response for a commit.

Inherits

  • Object

Example

require "google/cloud/firestore"

firestore = Google::Cloud::Firestore.new

commit_response = firestore.batch do |b|
  # Set the data for NYC
  b.set("cities/NYC", { name: "New York City" })

  # Update the population for SF
  b.update("cities/SF", { population: 1000000 })

  # Delete LA
  b.delete("cities/LA")
end

puts commit_response.commit_time
commit_response.write_results.each do |write_result|
  puts write_result.update_time
end

Methods

#commit_time

def commit_time() -> Time

The time at which the commit occurred.

Returns
  • (Time) — The commit time.

#commit_time=

def commit_time=(value) -> Time

The time at which the commit occurred.

Parameter
  • value (Time) — The commit time.
Returns
  • (Time) — The commit time.

#write_results

def write_results() -> Array<CommitResponse::WriteResult>

The result of applying the writes.

This i-th write result corresponds to the i-th write in the request.

Returns

#write_results=

def write_results=(value) -> Array<CommitResponse::WriteResult>

The result of applying the writes.

This i-th write result corresponds to the i-th write in the request.

Parameter
Returns