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.
#found=
def found=(value) -> ::Google::Cloud::Firestore::V1::Document
Parameter
- value (::Google::Cloud::Firestore::V1::Document) — A document that was requested.
Returns
- (::Google::Cloud::Firestore::V1::Document) — A document that was requested.
#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}
.
#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}
.
Returns
-
(::String) — A document name that was requested but does not exist. In the format:
projects/{project_id}/databases/{database_id}/documents/{document_path}
.
#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
- (::String) — 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.
#transaction=
def transaction=(value) -> ::String
Parameter
- value (::String) — 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.
Returns
- (::String) — 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.