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

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) — Required. The collection ID, relative to parent, to list. For example: chatrooms or messages.

#collection_id=

def collection_id=(value) -> ::String

Parameter

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

#mask

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

Returns

(::Google::Cloud::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.

#mask=

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

Parameter

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

Returns

(::Google::Cloud::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.

#order_by

def order_by() -> ::String

Returns

(::String) — The order to sort results by. For example: priority desc, name.

#order_by=

def order_by=(value) -> ::String

Parameter

value (::String) — The order to sort results by. For example: priority desc, name.

Returns

(::String) — The order to sort results by. For example: priority desc, name.

#page_size

def page_size() -> ::Integer

Returns

(::Integer) — The maximum number of documents to return.

#page_size=

def page_size=(value) -> ::Integer

Parameter

value (::Integer) — The maximum number of documents to return.

Returns

(::Integer) — The maximum number of documents to return.

#page_token

def page_token() -> ::String

Returns

(::String) — The next_page_token value returned from a previous List request, if any.

#page_token=

def page_token=(value) -> ::String

Parameter

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

#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) — Reads documents as they were at the given time. This may not be older than 270 seconds.

#read_time=

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

Parameter

value (::Google::Protobuf::Timestamp) — Reads documents as they were at the given time. This may not be older than 270 seconds.

Returns

(::Google::Protobuf::Timestamp) — Reads documents as they were at the given time. This may not be older than 270 seconds.

#show_missing

def show_missing() -> ::Boolean

Returns

(::Boolean) — 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.

#show_missing=

def show_missing=(value) -> ::Boolean

Parameter

value (::Boolean) — 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

(::Boolean) — 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.

#transaction

def transaction() -> ::String

Returns

(::String) — Reads documents in a transaction.

#transaction=

def transaction=(value) -> ::String

Parameter

value (::String) — Reads documents in a transaction.

Returns

(::String) — Reads documents in a transaction.