Class: Google::Apis::FirestoreV1beta1::BatchGetDocumentsRequest
- Inherits:
-
Object
- Object
- Google::Apis::FirestoreV1beta1::BatchGetDocumentsRequest
- 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 request for Firestore.BatchGetDocuments.
Instance Attribute Summary collapse
-
#documents ⇒ Array<String>
The names of the documents to retrieve.
-
#mask ⇒ Google::Apis::FirestoreV1beta1::DocumentMask
A set of field paths on a document.
-
#new_transaction ⇒ Google::Apis::FirestoreV1beta1::TransactionOptions
Options for creating a new transaction.
-
#read_time ⇒ String
Reads documents as they were at the given time.
-
#transaction ⇒ String
Reads documents in a transaction.
Instance Method Summary collapse
-
#initialize(**args) ⇒ BatchGetDocumentsRequest
constructor
A new instance of BatchGetDocumentsRequest.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ BatchGetDocumentsRequest
Returns a new instance of BatchGetDocumentsRequest
82 83 84 |
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 82 def initialize(**args) update!(**args) end |
Instance Attribute Details
#documents ⇒ Array<String>
The names of the documents to retrieve. In the format:
projects/
project_id/databases/
database_id/documents/
document_path`.
The request will fail if any of the document is not a child resource of the
given
database. Duplicate names will be elided.
Corresponds to the JSON property
documents`
54 55 56 |
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 54 def documents @documents end |
#mask ⇒ Google::Apis::FirestoreV1beta1::DocumentMask
A set of field paths on a document.
Used to restrict a get or update operation on a document to a subset of its
fields.
This is different from standard field masks, as this is always scoped to a
Document, and takes in account the dynamic nature of Value.
Corresponds to the JSON property mask
63 64 65 |
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 63 def mask @mask end |
#new_transaction ⇒ Google::Apis::FirestoreV1beta1::TransactionOptions
Options for creating a new transaction.
Corresponds to the JSON property newTransaction
68 69 70 |
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 68 def new_transaction @new_transaction end |
#read_time ⇒ String
Reads documents as they were at the given time.
This may not be older than 60 seconds.
Corresponds to the JSON property readTime
74 75 76 |
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 74 def read_time @read_time end |
#transaction ⇒ String
Reads documents in a transaction.
Corresponds to the JSON property transaction
NOTE: Values are automatically base64 encoded/decoded in the client library.
80 81 82 |
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 80 def transaction @transaction end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
87 88 89 90 91 92 93 |
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 87 def update!(**args) @documents = args[:documents] if args.key?(:documents) @mask = args[:mask] if args.key?(:mask) @new_transaction = args[:new_transaction] if args.key?(:new_transaction) @read_time = args[:read_time] if args.key?(:read_time) @transaction = args[:transaction] if args.key?(:transaction) end |