Class: Google::Firestore::V1beta1::ListDocumentsRequest

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

Overview

The request for Firestore::ListDocuments.

Instance Attribute Summary collapse

Instance Attribute Details

#collection_idString

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

Returns:

  • (String)

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



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

class ListDocumentsRequest; end

#maskGoogle::Firestore::V1beta1::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::V1beta1::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.



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

class ListDocumentsRequest; end

#order_byString

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.



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

class ListDocumentsRequest; end

#page_sizeInteger

Returns The maximum number of documents to return.

Returns:

  • (Integer)

    The maximum number of documents to return.



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

class ListDocumentsRequest; end

#page_tokenString

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.



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

class ListDocumentsRequest; end

#parentString

Returns 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)

    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



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

class ListDocumentsRequest; end

#read_timeGoogle::Protobuf::Timestamp

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

Returns:



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

class ListDocumentsRequest; end

#show_missingtrue, 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.



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

class ListDocumentsRequest; end

#transactionString

Returns Reads documents in a transaction.

Returns:

  • (String)

    Reads documents in a transaction.



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

class ListDocumentsRequest; end