Cloud Firestore V1 API - Class Google::Cloud::Firestore::V1::BatchGetDocumentsRequest (v0.11.0)

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

The request for Firestore.BatchGetDocuments.

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#database

def database() -> ::String

Returns

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

#database=

def database=(value) -> ::String

Parameter

value (::String) — 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}.

#documents

def documents() -> ::Array<::String>

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.

#documents=

def documents=(value) -> ::Array<::String>

Parameter

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

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.

#mask

def mask() -> ::Google::Cloud::Firestore::V1::DocumentMask

Returns

(::Google::Cloud::Firestore::V1::DocumentMask) — 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.

#mask=

def mask=(value) -> ::Google::Cloud::Firestore::V1::DocumentMask

Parameter

value (::Google::Cloud::Firestore::V1::DocumentMask) — 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

(::Google::Cloud::Firestore::V1::DocumentMask) — 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.

#new_transaction

def new_transaction() -> ::Google::Cloud::Firestore::V1::TransactionOptions

Returns

(::Google::Cloud::Firestore::V1::TransactionOptions) — 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.

#new_transaction=

def new_transaction=(value) -> ::Google::Cloud::Firestore::V1::TransactionOptions

Parameter

value (::Google::Cloud::Firestore::V1::TransactionOptions) — 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

(::Google::Cloud::Firestore::V1::TransactionOptions) — 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.

#read_time

def read_time() -> ::Google::Protobuf::Timestamp

Returns

(::Google::Protobuf::Timestamp) — Reads documents as they were at the given time.

This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days.

#read_time=

def read_time=(value) -> ::Google::Protobuf::Timestamp

Parameter

value (::Google::Protobuf::Timestamp) — Reads documents as they were at the given time.

This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days.

Returns

(::Google::Protobuf::Timestamp) — Reads documents as they were at the given time.

This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days.

#transaction

def transaction() -> ::String

Returns

(::String) — Reads documents in a transaction.

#transaction=

def transaction=(value) -> ::String

Parameter

value (::String) — Reads documents in a transaction.

Returns

(::String) — Reads documents in a transaction.