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

Inherits:

Object

• Object
• Google::Firestore::V1beta1::GetDocumentRequest

Defined in:

lib/google/cloud/firestore/v1beta1/doc/google/firestore/v1beta1/firestore.rb

Overview

The request for Firestore::GetDocument.

Instance Attribute Summary

• #mask ⇒ Google::Firestore::V1beta1::DocumentMask

  The fields to return.

• #name ⇒ String

  The resource name of the Document to get.

• #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::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.

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

class GetDocumentRequest; end

#name ⇒ String

Returns The resource name of the Document to get. In the format: +projects/project_id/databases/database_id/documents/document_path+.

Returns:

• (String) —

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

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

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:

• (Google::Protobuf::Timestamp) —

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

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

class GetDocumentRequest; end

#transaction ⇒ String

Returns Reads the document in a transaction.

Returns:

• (String) —

  Reads the document in a transaction.

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

class GetDocumentRequest; end