Struct google_api_proto::google::firestore::v1beta1::ListDocumentsRequest

pub struct ListDocumentsRequest {
    pub parent: String,
    pub collection_id: String,
    pub page_size: i32,
    pub page_token: String,
    pub order_by: String,
    pub mask: Option<DocumentMask>,
    pub show_missing: bool,
    pub consistency_selector: Option<ConsistencySelector>,
}

The request for [Firestore.ListDocuments][google.firestore.v1beta1.Firestore.ListDocuments].

Fields

parent: 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

collection_id: String

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

page_size: i32

The maximum number of documents to return.

page_token: String

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

order_by: String

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

mask: Option<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.

show_missing: bool

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][google.firestore.v1beta1.Document.create_time], or [Document.update_time][google.firestore.v1beta1.Document.update_time] set.

Requests with show_missing may not specify where or order_by.

consistency_selector: Option<ConsistencySelector>

The consistency mode for this transaction. If not set, defaults to strong consistency.

Trait Implementations

impl Clone for ListDocumentsRequest

fn clone(&self) -> ListDocumentsRequest

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ListDocumentsRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ListDocumentsRequest

fn default() -> Self

Returns the “default value” for a type.

impl Message for ListDocumentsRequest

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for ListDocumentsRequest

fn eq(&self, other: &ListDocumentsRequest) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ListDocumentsRequest