Class: Google::Cloud::Firestore::V1::GetDocumentRequest
- Inherits:
-
Object
- Object
- Google::Cloud::Firestore::V1::GetDocumentRequest
- Extended by:
- Protobuf::MessageExts::ClassMethods
- Includes:
- Protobuf::MessageExts
- Defined in:
- proto_docs/google/firestore/v1/firestore.rb
Overview
The request for Firestore.GetDocument.
Instance Attribute Summary collapse
-
#mask ⇒ ::Google::Cloud::Firestore::V1::DocumentMask
The fields to return.
-
#name ⇒ ::String
Required.
-
#read_time ⇒ ::Google::Protobuf::Timestamp
Reads the version of the document at the given time.
-
#transaction ⇒ ::String
Reads the document in a transaction.
Instance Attribute Details
#mask ⇒ ::Google::Cloud::Firestore::V1::DocumentMask
Returns 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.
46 47 48 49 |
# File 'proto_docs/google/firestore/v1/firestore.rb', line 46 class GetDocumentRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#name ⇒ ::String
Returns Required. The resource name of the Document to get. In the format:
projects/{project_id}/databases/{database_id}/documents/{document_path}
.
46 47 48 49 |
# File 'proto_docs/google/firestore/v1/firestore.rb', line 46 class GetDocumentRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#read_time ⇒ ::Google::Protobuf::Timestamp
Returns Reads the version of the document 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.
46 47 48 49 |
# File 'proto_docs/google/firestore/v1/firestore.rb', line 46 class GetDocumentRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#transaction ⇒ ::String
Returns Reads the document in a transaction.
46 47 48 49 |
# File 'proto_docs/google/firestore/v1/firestore.rb', line 46 class GetDocumentRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |