Reference documentation and code samples for the Cloud Firestore V1 API class Google::Cloud::Firestore::V1::GetDocumentRequest.
The request for Firestore.GetDocument.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#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 the 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 the 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 the document has a field that is not present in this mask, that field will not be returned in the response.
#name
def name() -> ::String
Returns
-
(::String) — Required. The resource name of the Document to get. In the format:
projects/{project_id}/databases/{database_id}/documents/{document_path}.
#name=
def name=(value) -> ::String
Parameter
-
value (::String) — Required. The resource name of the Document to get. In the format:
projects/{project_id}/databases/{database_id}/documents/{document_path}.
Returns
-
(::String) — Required. The resource name of the Document to get. In the format:
projects/{project_id}/databases/{database_id}/documents/{document_path}.
#read_time
def read_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Reads the version of the document at the given time. This may not be older than 270 seconds.
#read_time=
def read_time=(value) -> ::Google::Protobuf::Timestamp
Parameter
- value (::Google::Protobuf::Timestamp) — Reads the version of the document at the given time. This may not be older than 270 seconds.
Returns
- (::Google::Protobuf::Timestamp) — Reads the version of the document at the given time. This may not be older than 270 seconds.
#transaction
def transaction() -> ::String
Returns
- (::String) — Reads the document in a transaction.
#transaction=
def transaction=(value) -> ::String
Parameter
- value (::String) — Reads the document in a transaction.
Returns
- (::String) — Reads the document in a transaction.