Class: Google::Firestore::V1::ListDocumentsRequest

Inherits:

Object

• Object
• Google::Firestore::V1::ListDocumentsRequest

Defined in:

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

Overview

The request for Firestore::ListDocuments.

Instance Attribute Summary

• #collection_id ⇒ String

  Required.

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

  The fields to return.

• #order_by ⇒ String

  The order to sort results by.

• #page_size ⇒ Integer

  The maximum number of documents to return.

• #page_token ⇒ String

  The next_page_token value returned from a previous List request, if any.

• #parent ⇒ String

  Required.

• #read_time ⇒ Google::Protobuf::Timestamp

  Reads documents as they were at the given time.

• #show_missing ⇒ true, false

  If the list should show missing documents.

• #transaction ⇒ String

  Reads documents in a transaction.

Instance Attribute Details

#collection_id ⇒ String

Returns Required. The collection ID, relative to parent, to list. For example: chatrooms or messages.

Returns:

• (String) —

  Required. The collection ID, relative to parent, to list. For example: chatrooms or messages.

# File 'lib/google/cloud/firestore/v1/doc/google/firestore/v1/firestore.rb', line 83

class ListDocumentsRequest; end

#mask ⇒ Google::Firestore::V1::DocumentMask

Returns The fields to return. If not set, returns all fields.

If a document has a field that is not present in this mask, that field will not be returned in the response.

Returns:

• (Google::Firestore::V1::DocumentMask) —

  The fields to return. If not set, returns all fields.

  If a 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/v1/doc/google/firestore/v1/firestore.rb', line 83

class ListDocumentsRequest; end

#order_by ⇒ String

Returns The order to sort results by. For example: priority desc, name.

Returns:

• (String) —

  The order to sort results by. For example: priority desc, name.

# File 'lib/google/cloud/firestore/v1/doc/google/firestore/v1/firestore.rb', line 83

class ListDocumentsRequest; end

#page_size ⇒ Integer

Returns The maximum number of documents to return.

Returns:

• (Integer) —

  The maximum number of documents to return.

# File 'lib/google/cloud/firestore/v1/doc/google/firestore/v1/firestore.rb', line 83

class ListDocumentsRequest; end

#page_token ⇒ String

Returns The next_page_token value returned from a previous List request, if any.

Returns:

• (String) —

  The next_page_token value returned from a previous List request, if any.

# File 'lib/google/cloud/firestore/v1/doc/google/firestore/v1/firestore.rb', line 83

class ListDocumentsRequest; end

#parent ⇒ String

Returns Required. The parent resource name. In the format: projects/{project_id}/databases/{database_id}/documents or projects/{project_id}/databases/{database_id}/documents/{document_path}. For example: projects/my-project/databases/my-database/documents or projects/my-project/databases/my-database/documents/chatrooms/my-chatroom.

Returns:

• (String) —

  Required. The parent resource name. In the format: projects/{project_id}/databases/{database_id}/documents or projects/{project_id}/databases/{database_id}/documents/{document_path}. For example: projects/my-project/databases/my-database/documents or projects/my-project/databases/my-database/documents/chatrooms/my-chatroom

# File 'lib/google/cloud/firestore/v1/doc/google/firestore/v1/firestore.rb', line 83

class ListDocumentsRequest; end

#read_time ⇒ Google::Protobuf::Timestamp

Returns Reads documents as they were at the given time. This may not be older than 60 seconds.

Returns:

• (Google::Protobuf::Timestamp) —

  Reads documents as they were at the given time. This may not be older than 60 seconds.

# File 'lib/google/cloud/firestore/v1/doc/google/firestore/v1/firestore.rb', line 83

class ListDocumentsRequest; end

#show_missing ⇒ true, false

Returns If the list should show missing documents. A missing document is a document that does not exist but has sub-documents. These documents will be returned with a key but will not have fields, Document#create_time, or Document#update_time set.

Requests with show_missing may not specify where or order_by.

Returns:

• (true, false) —

  If the list should show missing documents. A missing document is a document that does not exist but has sub-documents. These documents will be returned with a key but will not have fields, Document#create_time, or Document#update_time set.

  Requests with show_missing may not specify where or order_by.

# File 'lib/google/cloud/firestore/v1/doc/google/firestore/v1/firestore.rb', line 83

class ListDocumentsRequest; end

#transaction ⇒ String

Returns Reads documents in a transaction.

Returns:

• (String) —

  Reads documents in a transaction.

# File 'lib/google/cloud/firestore/v1/doc/google/firestore/v1/firestore.rb', line 83

class ListDocumentsRequest; end