Cloud Firestore V1 API - Class Google::Cloud::Firestore::V1::BatchGetDocumentsResponse (v1.3.0)

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

The streamed response for Firestore.BatchGetDocuments.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#found

def found() -> ::Google::Cloud::Firestore::V1::Document
Returns
  • (::Google::Cloud::Firestore::V1::Document) — A document that was requested.

    Note: The following fields are mutually exclusive: found, missing. If a field in that set is populated, all other fields in the set will automatically be cleared.

#found=

def found=(value) -> ::Google::Cloud::Firestore::V1::Document
Parameter
  • value (::Google::Cloud::Firestore::V1::Document) — A document that was requested.

    Note: The following fields are mutually exclusive: found, missing. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::Firestore::V1::Document) — A document that was requested.

    Note: The following fields are mutually exclusive: found, missing. If a field in that set is populated, all other fields in the set will automatically be cleared.

#missing

def missing() -> ::String
Returns
  • (::String) — A document name that was requested but does not exist. In the format: projects/{project_id}/databases/{database_id}/documents/{document_path}.

    Note: The following fields are mutually exclusive: missing, found. If a field in that set is populated, all other fields in the set will automatically be cleared.

#missing=

def missing=(value) -> ::String
Parameter
  • value (::String) — A document name that was requested but does not exist. In the format: projects/{project_id}/databases/{database_id}/documents/{document_path}.

    Note: The following fields are mutually exclusive: missing, found. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::String) — A document name that was requested but does not exist. In the format: projects/{project_id}/databases/{database_id}/documents/{document_path}.

    Note: The following fields are mutually exclusive: missing, found. If a field in that set is populated, all other fields in the set will automatically be cleared.

#read_time

def read_time() -> ::Google::Protobuf::Timestamp
Returns
  • (::Google::Protobuf::Timestamp) — 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.

#read_time=

def read_time=(value) -> ::Google::Protobuf::Timestamp
Parameter
  • value (::Google::Protobuf::Timestamp) — 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.
Returns
  • (::Google::Protobuf::Timestamp) — 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.

#transaction

def transaction() -> ::String
Returns

#transaction=

def transaction=(value) -> ::String
Parameter
Returns