Struct gapi_grpc::google::firestore::v1::ListDocumentsRequest

[+] Show declaration

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>,
}

[−] Expand description

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

Fields

parent: String

[−] Expand description

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

[−] Expand description

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

page_size: i32

[−] Expand description

The maximum number of documents to return.

page_token: String

[−] Expand description

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

order_by: String

[−] Expand description

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

mask: Option<DocumentMask>

[−] Expand description

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

[−] Expand description

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

Requests with show_missing may not specify where or order_by.

consistency_selector: Option<ConsistencySelector>

[−] Expand description

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

Trait Implementations

impl Clone for ListDocumentsRequest[+]

[+] Show hidden undocumented items

fn clone(&self) -> ListDocumentsRequest[−]

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)[−]

Performs copy-assignment from source.

impl Debug for ListDocumentsRequest[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl Default for ListDocumentsRequest[+]

[+] Show hidden undocumented items

fn default() -> ListDocumentsRequest[−]

Returns the “default value” for a type.

impl Message for ListDocumentsRequest[+]

[+] Show hidden undocumented items

fn encode_raw<B>(&self, buf: &mut B) where
    B: BufMut, 

fn merge_field<B>(
    &mut self,
    tag: u32,
    wire_type: WireType,
    buf: &mut B,
    ctx: DecodeContext
) -> Result<(), DecodeError> where
    B: Buf, 

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.

pub fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, [−]

Encodes the message to a buffer.

pub fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, [−]

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

pub fn decode<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, [−]

Decodes an instance of the message from a buffer.

pub fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, [−]

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

pub fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, [−]

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

pub fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, [−]

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

impl PartialEq<ListDocumentsRequest> for ListDocumentsRequest[+]

[+] Show hidden undocumented items

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: &ListDocumentsRequest) -> bool[−]

This method tests for !=.

impl StructuralPartialEq for ListDocumentsRequest