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

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/firestore/v1/firestore.rb

Overview

The request for Firestore.ListDocuments.

Instance Attribute Summary collapse

Instance Attribute Details

#collection_id ⇒ ::String

Returns Optional. The collection ID, relative to parent, to list.

For example: chatrooms or messages.

This is optional, and when not provided, Firestore will list documents from all collections under the provided parent.

Returns:

  • (::String) —

    Optional. The collection ID, relative to parent, to list.

    For example: chatrooms or messages.

    This is optional, and when not provided, Firestore will list documents from all collections under the provided parent.



126
127
128
129
 
# File 'proto_docs/google/firestore/v1/firestore.rb', line 126

class ListDocumentsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

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

Returns Optional. 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::Cloud::Firestore::V1::DocumentMask) —

    Optional. 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.



126
127
128
129
 
# File 'proto_docs/google/firestore/v1/firestore.rb', line 126

class ListDocumentsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#order_by ⇒ ::String

Returns Optional. The optional ordering of the documents to return.

For example: priority desc, __name__ desc.

This mirrors the ORDER BY used in Firestore queries but in a string representation. When absent, documents are ordered based on __name__ ASC.

Returns:

  • (::String) —

    Optional. The optional ordering of the documents to return.

    For example: priority desc, __name__ desc.

    This mirrors the ORDER BY used in Firestore queries but in a string representation. When absent, documents are ordered based on __name__ ASC.



126
127
128
129
 
# File 'proto_docs/google/firestore/v1/firestore.rb', line 126

class ListDocumentsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#page_size ⇒ ::Integer

Returns Optional. The maximum number of documents to return in a single response.

Firestore may return fewer than this value.

Returns:

  • (::Integer) —

    Optional. The maximum number of documents to return in a single response.

    Firestore may return fewer than this value.



126
127
128
129
 
# File 'proto_docs/google/firestore/v1/firestore.rb', line 126

class ListDocumentsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#page_token ⇒ ::String

Returns Optional. A page token, received from a previous ListDocuments response.

Provide this to retrieve the subsequent page. When paginating, all other parameters (with the exception of page_size) must match the values set in the request that generated the page token.

Returns:

  • (::String) —

    Optional. A page token, received from a previous ListDocuments response.

    Provide this to retrieve the subsequent page. When paginating, all other parameters (with the exception of page_size) must match the values set in the request that generated the page token.



126
127
128
129
 
# File 'proto_docs/google/firestore/v1/firestore.rb', line 126

class ListDocumentsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
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



126
127
128
129
 
# File 'proto_docs/google/firestore/v1/firestore.rb', line 126

class ListDocumentsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#read_time ⇒ ::Google::Protobuf::Timestamp

Returns Perform the read at the provided 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.

Note: The following fields are mutually exclusive: read_time, transaction. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Protobuf::Timestamp) —

    Perform the read at the provided 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.

    Note: The following fields are mutually exclusive: read_time, transaction. If a field in that set is populated, all other fields in the set will automatically be cleared.



126
127
128
129
 
# File 'proto_docs/google/firestore/v1/firestore.rb', line 126

class ListDocumentsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#show_missing ⇒ ::Boolean

Returns If the list should show missing documents.

A document is missing if it does not exist, but there are sub-documents nested underneath it. When true, such missing documents will be returned with a key but will not have fields, create_time, or update_time set.

Requests with show_missing may not specify where or order_by.

Returns:

  • (::Boolean) —

    If the list should show missing documents.

    A document is missing if it does not exist, but there are sub-documents nested underneath it. When true, such missing documents will be returned with a key but will not have fields, create_time, or update_time set.

    Requests with show_missing may not specify where or order_by.



126
127
128
129
 
# File 'proto_docs/google/firestore/v1/firestore.rb', line 126

class ListDocumentsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#transaction ⇒ ::String

Returns Perform the read as part of an already active transaction.

Note: The following fields are mutually exclusive: transaction, read_time. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::String) —

    Perform the read as part of an already active transaction.

    Note: The following fields are mutually exclusive: transaction, read_time. If a field in that set is populated, all other fields in the set will automatically be cleared.



126
127
128
129
 
# File 'proto_docs/google/firestore/v1/firestore.rb', line 126

class ListDocumentsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end