Class: Google::Firestore::V1beta1::GetDocumentRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/firestore/v1beta1/doc/google/firestore/v1beta1/firestore.rb

Overview

The request for Firestore::GetDocument.

Instance Attribute Summary collapse

Instance Attribute Details

#mask ⇒ Google::Firestore::V1beta1::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.

Returns:

  • (Google::Firestore::V1beta1::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.



37
 
# File 'lib/google/cloud/firestore/v1beta1/doc/google/firestore/v1beta1/firestore.rb', line 37

class GetDocumentRequest; 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}.

Returns:

  • (String) —

    Required. The resource name of the Document to get. In the format: projects/{project_id}/databases/{database_id}/documents/{document_path}.



37
 
# File 'lib/google/cloud/firestore/v1beta1/doc/google/firestore/v1beta1/firestore.rb', line 37

class GetDocumentRequest; end

#read_time ⇒ Google::Protobuf::Timestamp

Returns Reads the version of the document at the given time. This may not be older than 60 seconds.

Returns:



37
 
# File 'lib/google/cloud/firestore/v1beta1/doc/google/firestore/v1beta1/firestore.rb', line 37

class GetDocumentRequest; end

#transaction ⇒ String

Returns Reads the document in a transaction.

Returns:

  • (String) —

    Reads the document in a transaction.



37
 
# File 'lib/google/cloud/firestore/v1beta1/doc/google/firestore/v1beta1/firestore.rb', line 37

class GetDocumentRequest; end