Class: Google::Cloud::Firestore::V1::BatchGetDocumentsRequest

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/firestore/v1/firestore.rb

Overview

The request for Firestore.BatchGetDocuments.

Instance Attribute Summary collapse

Instance Attribute Details

#database::String

Returns Required. The database name. In the format: projects/{project_id}/databases/{database_id}.

Returns:

  • (::String)

    Required. The database name. In the format: projects/{project_id}/databases/{database_id}.



209
210
211
212
# File 'proto_docs/google/firestore/v1/firestore.rb', line 209

class BatchGetDocumentsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#documents::Array<::String>

Returns 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.

Returns:

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



209
210
211
212
# File 'proto_docs/google/firestore/v1/firestore.rb', line 209

class BatchGetDocumentsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#mask::Google::Cloud::Firestore::V1::DocumentMask

Returns The fields to return. If not set, returns all fields.

If a document has a field that is not present in this mask, that field will not be returned in the response.

Returns:



209
210
211
212
# File 'proto_docs/google/firestore/v1/firestore.rb', line 209

class BatchGetDocumentsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#new_transaction::Google::Cloud::Firestore::V1::TransactionOptions

Returns Starts a new transaction and reads the documents. Defaults to a read-only transaction. The new transaction ID will be returned as the first response in the stream.

Returns:



209
210
211
212
# File 'proto_docs/google/firestore/v1/firestore.rb', line 209

class BatchGetDocumentsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#read_time::Google::Protobuf::Timestamp

Returns Reads documents as they were at the given time. This may not be older than 270 seconds.

Returns:



209
210
211
212
# File 'proto_docs/google/firestore/v1/firestore.rb', line 209

class BatchGetDocumentsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#transaction::String

Returns Reads documents in a transaction.

Returns:

  • (::String)

    Reads documents in a transaction.



209
210
211
212
# File 'proto_docs/google/firestore/v1/firestore.rb', line 209

class BatchGetDocumentsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end