Class: Google::Apis::FirestoreV1beta1::BatchGetDocumentsResponse

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/firestore_v1beta1/classes.rb,
generated/google/apis/firestore_v1beta1/representations.rb,
generated/google/apis/firestore_v1beta1/representations.rb

Overview

The streamed response for Firestore.BatchGetDocuments.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ BatchGetDocumentsResponse

Returns a new instance of BatchGetDocumentsResponse.


125
126
127
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 125

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

Instance Attribute Details

#foundGoogle::Apis::FirestoreV1beta1::Document

A Firestore document. Must not exceed 1 MiB - 4 bytes. Corresponds to the JSON property found


102
103
104
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 102

def found
  @found
end

#missingString

A document name that was requested but does not exist. In the format: projects/project_id/databases/database_id/documents/document_path`. Corresponds to the JSON propertymissing`

Returns:

  • (String)

108
109
110
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 108

def missing
  @missing
end

#read_timeString

The time at which the document was read. This may be monotically increasing, in this case the previous documents in the result stream are guaranteed not to have changed between their read_time and this one. Corresponds to the JSON property readTime

Returns:

  • (String)

115
116
117
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 115

def read_time
  @read_time
end

#transactionString

The transaction that was started as part of this request. Will only be set in the first response, and only if BatchGetDocumentsRequest.new_transaction was set in the request. Corresponds to the JSON property transaction NOTE: Values are automatically base64 encoded/decoded in the client library.

Returns:

  • (String)

123
124
125
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 123

def transaction
  @transaction
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


130
131
132
133
134
135
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 130

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