Cloud Firestore V1 API - Class Google::Cloud::Firestore::V1::ListDocumentsRequest (v0.12.0)

Version 0.12.0

• 1.2.0 (latest)
• 1.1.1
• 1.0.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.1
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.1
• 0.6.0
• 0.5.0
• 0.4.8

Reference documentation and code samples for the Cloud Firestore V1 API class Google::Cloud::Firestore::V1::ListDocumentsRequest.

The request for Firestore.ListDocuments.

Inherits

• Object

Extended By

• Google::Protobuf::MessageExts::ClassMethods

Includes

• Google::Protobuf::MessageExts

Methods

#collection_id

def collection_id() -> ::String

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.

#collection_id=

def collection_id=(value) -> ::String

Parameter

• value (::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.

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.

#mask

def mask() -> ::Google::Cloud::Firestore::V1::DocumentMask

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.

#mask=

def mask=(value) -> ::Google::Cloud::Firestore::V1::DocumentMask

Parameter

• value (::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.

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.

#order_by

def order_by() -> ::String

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.

#order_by=

def order_by=(value) -> ::String

Parameter

• value (::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.

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.

#page_size

def page_size() -> ::Integer

Returns

• (::Integer) — Optional. The maximum number of documents to return in a single response.

  Firestore may return fewer than this value.

#page_size=

def page_size=(value) -> ::Integer

Parameter

• value (::Integer) — 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.

#page_token

def page_token() -> ::String

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.

#page_token=

def page_token=(value) -> ::String

Parameter

• value (::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.

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.

#parent

def parent() -> ::String

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

#parent=

def parent=(value) -> ::String

Parameter

• value (::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

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

#read_time

def read_time() -> ::Google::Protobuf::Timestamp

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.

#read_time=

def read_time=(value) -> ::Google::Protobuf::Timestamp

Parameter

• value (::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.

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.

#show_missing

def show_missing() -> ::Boolean

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.

#show_missing=

def show_missing=(value) -> ::Boolean

Parameter

• value (::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.

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.

#transaction

def transaction() -> ::String

Returns

• (::String) — Perform the read as part of an already active transaction.

#transaction=

def transaction=(value) -> ::String

Parameter

• value (::String) — Perform the read as part of an already active transaction.

Returns

• (::String) — Perform the read as part of an already active transaction.