Struct firestore_serde::firestore::ListDocumentsRequest
source · [−]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
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.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>
The consistency mode for this transaction. If not set, defaults to strong consistency.
Trait Implementations
Returns the “default value” for a type. Read more
pub fn merge_field<B>(
&mut self,
tag: u32,
wire_type: WireType,
buf: &mut B,
ctx: DecodeContext
) -> Result<(), DecodeError> where
B: Buf,
Returns the encoded length of the message without a length delimiter.
Encodes the message to a buffer. Read more
Encodes the message to a newly allocated buffer.
Encodes the message with a length-delimiter to a buffer. Read more
Encodes the message with a length-delimiter to a newly allocated buffer.
Decodes an instance of the message from a buffer. Read more
fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
B: Buf,
Self: Default,
fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
B: Buf,
Self: Default,
Decodes a length-delimited instance of the message from the buffer.
Decodes an instance of the message from a buffer, and merges it into self
. Read more
Decodes a length-delimited instance of the message from buffer, and
merges it into self
. Read more
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
This method tests for !=
.
Auto Trait Implementations
impl RefUnwindSafe for ListDocumentsRequest
impl Send for ListDocumentsRequest
impl Sync for ListDocumentsRequest
impl Unpin for ListDocumentsRequest
impl UnwindSafe for ListDocumentsRequest
Blanket Implementations
Mutably borrows from an owned value. Read more
Wrap the input message T
in a tonic::Request
pub fn vzip(self) -> V
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more