pub struct ProjectDatabaseDocumentListDocumentCall<'a, S>where
S: 'a,{ /* private fields */ }Expand description
Lists documents.
A builder for the databases.documents.listDocuments method supported by a project resource.
It is not used directly, but through a ProjectMethods instance.
§Example
Instantiate a resource method builder
// You can configure optional parameters by calling the respective setters at will, and
// execute the final call using `doit()`.
// Values shown here are possibly random and not representative !
let result = hub.projects().databases_documents_list_documents("parent", "collectionId")
.transaction(vec![0, 1, 2, 3])
.show_missing(true)
.read_time(chrono::Utc::now())
.page_token("ipsum")
.page_size(-50)
.order_by("est")
.add_mask_field_paths("gubergren")
.doit().await;Implementations§
source§impl<'a, S> ProjectDatabaseDocumentListDocumentCall<'a, S>
impl<'a, S> ProjectDatabaseDocumentListDocumentCall<'a, S>
sourcepub async fn doit(self) -> Result<(Response<Body>, ListDocumentsResponse)>
pub async fn doit(self) -> Result<(Response<Body>, ListDocumentsResponse)>
Perform the operation you have build so far.
sourcepub fn parent(
self,
new_value: &str
) -> ProjectDatabaseDocumentListDocumentCall<'a, S>
pub fn parent( self, new_value: &str ) -> ProjectDatabaseDocumentListDocumentCall<'a, S>
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
Sets the parent path property to the given value.
Even though the property as already been set when instantiating this call, we provide this method for API completeness.
sourcepub fn collection_id(
self,
new_value: &str
) -> ProjectDatabaseDocumentListDocumentCall<'a, S>
pub fn collection_id( self, new_value: &str ) -> ProjectDatabaseDocumentListDocumentCall<'a, S>
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.
Sets the collection id path property to the given value.
Even though the property as already been set when instantiating this call, we provide this method for API completeness.
sourcepub fn transaction(
self,
new_value: Vec<u8>
) -> ProjectDatabaseDocumentListDocumentCall<'a, S>
pub fn transaction( self, new_value: Vec<u8> ) -> ProjectDatabaseDocumentListDocumentCall<'a, S>
Perform the read as part of an already active transaction.
Sets the transaction query property to the given value.
sourcepub fn show_missing(
self,
new_value: bool
) -> ProjectDatabaseDocumentListDocumentCall<'a, S>
pub fn show_missing( self, new_value: bool ) -> ProjectDatabaseDocumentListDocumentCall<'a, S>
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.
Sets the show missing query property to the given value.
sourcepub fn read_time(
self,
new_value: DateTime<Utc>
) -> ProjectDatabaseDocumentListDocumentCall<'a, S>
pub fn read_time( self, new_value: DateTime<Utc> ) -> ProjectDatabaseDocumentListDocumentCall<'a, S>
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.
Sets the read time query property to the given value.
sourcepub fn page_token(
self,
new_value: &str
) -> ProjectDatabaseDocumentListDocumentCall<'a, S>
pub fn page_token( self, new_value: &str ) -> ProjectDatabaseDocumentListDocumentCall<'a, S>
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.
Sets the page token query property to the given value.
sourcepub fn page_size(
self,
new_value: i32
) -> ProjectDatabaseDocumentListDocumentCall<'a, S>
pub fn page_size( self, new_value: i32 ) -> ProjectDatabaseDocumentListDocumentCall<'a, S>
Optional. The maximum number of documents to return in a single response. Firestore may return fewer than this value.
Sets the page size query property to the given value.
sourcepub fn order_by(
self,
new_value: &str
) -> ProjectDatabaseDocumentListDocumentCall<'a, S>
pub fn order_by( self, new_value: &str ) -> ProjectDatabaseDocumentListDocumentCall<'a, S>
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.
Sets the order by query property to the given value.
sourcepub fn add_mask_field_paths(
self,
new_value: &str
) -> ProjectDatabaseDocumentListDocumentCall<'a, S>
pub fn add_mask_field_paths( self, new_value: &str ) -> ProjectDatabaseDocumentListDocumentCall<'a, S>
The list of field paths in the mask. See Document.fields for a field path syntax reference.
Append the given value to the mask.field paths query property. Each appended value will retain its original ordering and be ‘/’-separated in the URL’s parameters.
sourcepub fn delegate(
self,
new_value: &'a mut dyn Delegate
) -> ProjectDatabaseDocumentListDocumentCall<'a, S>
pub fn delegate( self, new_value: &'a mut dyn Delegate ) -> ProjectDatabaseDocumentListDocumentCall<'a, S>
The delegate implementation is consulted whenever there is an intermediate result, or if something goes wrong while executing the actual API request.
It should be used to handle progress information, and to implement a certain level of resilience.
Sets the delegate property to the given value.
sourcepub fn param<T>(
self,
name: T,
value: T
) -> ProjectDatabaseDocumentListDocumentCall<'a, S>
pub fn param<T>( self, name: T, value: T ) -> ProjectDatabaseDocumentListDocumentCall<'a, S>
Set any additional parameter of the query string used in the request. It should be used to set parameters which are not yet available through their own setters.
Please note that this method must not be used to set any of the known parameters which have their own setter method. If done anyway, the request will fail.
§Additional Parameters
- $.xgafv (query-string) - V1 error format.
- access_token (query-string) - OAuth access token.
- alt (query-string) - Data format for response.
- callback (query-string) - JSONP
- fields (query-string) - Selector specifying which fields to include in a partial response.
- key (query-string) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- oauth_token (query-string) - OAuth 2.0 token for the current user.
- prettyPrint (query-boolean) - Returns response with indentations and line breaks.
- quotaUser (query-string) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- uploadType (query-string) - Legacy upload protocol for media (e.g. “media”, “multipart”).
- upload_protocol (query-string) - Upload protocol for media (e.g. “raw”, “multipart”).
sourcepub fn add_scope<St>(
self,
scope: St
) -> ProjectDatabaseDocumentListDocumentCall<'a, S>
pub fn add_scope<St>( self, scope: St ) -> ProjectDatabaseDocumentListDocumentCall<'a, S>
Identifies the authorization scope for the method you are building.
Use this method to actively specify which scope should be used, instead of the default Scope variant
Scope::CloudPlatform.
The scope will be added to a set of scopes. This is important as one can maintain access
tokens for more than one scope.
Usually there is more than one suitable scope to authorize an operation, some of which may encompass more rights than others. For example, for listing resources, a read-only scope will be sufficient, a read-write scope will do as well.
sourcepub fn add_scopes<I, St>(
self,
scopes: I
) -> ProjectDatabaseDocumentListDocumentCall<'a, S>
pub fn add_scopes<I, St>( self, scopes: I ) -> ProjectDatabaseDocumentListDocumentCall<'a, S>
Identifies the authorization scope(s) for the method you are building.
See Self::add_scope() for details.
sourcepub fn clear_scopes(self) -> ProjectDatabaseDocumentListDocumentCall<'a, S>
pub fn clear_scopes(self) -> ProjectDatabaseDocumentListDocumentCall<'a, S>
Removes all scopes, and no default scope will be used either.
In this case, you have to specify your API-key using the key parameter (see Self::param()
for details).