Struct google_firestore1_beta1::ProjectDatabaseDocumentListCall [−][src]
pub struct ProjectDatabaseDocumentListCall<'a, C, A> where
C: 'a,
A: 'a, { /* fields omitted */ }
Lists documents.
A builder for the databases.documents.list 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("parent", "collectionId") .transaction("Lorem") .show_missing(true) .read_time("duo") .page_token("aliquyam") .page_size(-9) .order_by("Lorem") .add_mask_field_paths("eos") .doit();
Methods
impl<'a, C, A> ProjectDatabaseDocumentListCall<'a, C, A> where
C: BorrowMut<Client>,
A: GetToken,
[src]
impl<'a, C, A> ProjectDatabaseDocumentListCall<'a, C, A> where
C: BorrowMut<Client>,
A: GetToken,
pub fn doit(self) -> Result<(Response, ListDocumentsResponse)>
[src]
pub fn doit(self) -> Result<(Response, ListDocumentsResponse)>
Perform the operation you have build so far.
pub fn parent(
self,
new_value: &str
) -> ProjectDatabaseDocumentListCall<'a, C, A>
[src]
pub fn parent(
self,
new_value: &str
) -> ProjectDatabaseDocumentListCall<'a, C, A>
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.
pub fn collection_id(
self,
new_value: &str
) -> ProjectDatabaseDocumentListCall<'a, C, A>
[src]
pub fn collection_id(
self,
new_value: &str
) -> ProjectDatabaseDocumentListCall<'a, C, A>
The collection ID, relative to parent
, to list. For example: chatrooms
or messages
.
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.
pub fn transaction(
self,
new_value: &str
) -> ProjectDatabaseDocumentListCall<'a, C, A>
[src]
pub fn transaction(
self,
new_value: &str
) -> ProjectDatabaseDocumentListCall<'a, C, A>
Reads documents in a transaction.
Sets the transaction query property to the given value.
pub fn show_missing(
self,
new_value: bool
) -> ProjectDatabaseDocumentListCall<'a, C, A>
[src]
pub fn show_missing(
self,
new_value: bool
) -> ProjectDatabaseDocumentListCall<'a, C, A>
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
.
Sets the show missing query property to the given value.
pub fn read_time(
self,
new_value: &str
) -> ProjectDatabaseDocumentListCall<'a, C, A>
[src]
pub fn read_time(
self,
new_value: &str
) -> ProjectDatabaseDocumentListCall<'a, C, A>
Reads documents as they were at the given time. This may not be older than 60 seconds.
Sets the read time query property to the given value.
pub fn page_token(
self,
new_value: &str
) -> ProjectDatabaseDocumentListCall<'a, C, A>
[src]
pub fn page_token(
self,
new_value: &str
) -> ProjectDatabaseDocumentListCall<'a, C, A>
The next_page_token
value returned from a previous List request, if any.
Sets the page token query property to the given value.
pub fn page_size(
self,
new_value: i32
) -> ProjectDatabaseDocumentListCall<'a, C, A>
[src]
pub fn page_size(
self,
new_value: i32
) -> ProjectDatabaseDocumentListCall<'a, C, A>
The maximum number of documents to return.
Sets the page size query property to the given value.
pub fn order_by(
self,
new_value: &str
) -> ProjectDatabaseDocumentListCall<'a, C, A>
[src]
pub fn order_by(
self,
new_value: &str
) -> ProjectDatabaseDocumentListCall<'a, C, A>
The order to sort results by. For example: priority desc, name
.
Sets the order by query property to the given value.
pub fn add_mask_field_paths(
self,
new_value: &str
) -> ProjectDatabaseDocumentListCall<'a, C, A>
[src]
pub fn add_mask_field_paths(
self,
new_value: &str
) -> ProjectDatabaseDocumentListCall<'a, C, A>
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.
pub fn delegate(
self,
new_value: &'a mut Delegate
) -> ProjectDatabaseDocumentListCall<'a, C, A>
[src]
pub fn delegate(
self,
new_value: &'a mut Delegate
) -> ProjectDatabaseDocumentListCall<'a, C, A>
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.
pub fn param<T>(
self,
name: T,
value: T
) -> ProjectDatabaseDocumentListCall<'a, C, A> where
T: AsRef<str>,
[src]
pub fn param<T>(
self,
name: T,
value: T
) -> ProjectDatabaseDocumentListCall<'a, C, A> where
T: AsRef<str>,
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 paramters which have their own setter method. If done anyway, the request will fail.
Additional Parameters
- bearer_token (query-string) - OAuth bearer token.
- pp (query-boolean) - Pretty-print response.
- prettyPrint (query-boolean) - Returns response with indentations and line breaks.
- upload_protocol (query-string) - Upload protocol for media (e.g. "raw", "multipart").
- access_token (query-string) - OAuth access token.
- uploadType (query-string) - Legacy upload protocol for media (e.g. "media", "multipart").
- 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.
- callback (query-string) - JSONP
- oauth_token (query-string) - OAuth 2.0 token for the current user.
- 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.
- fields (query-string) - Selector specifying which fields to include in a partial response.
- alt (query-string) - Data format for response.
- $.xgafv (query-string) - V1 error format.
pub fn add_scope<T, S>(
self,
scope: T
) -> ProjectDatabaseDocumentListCall<'a, C, A> where
T: Into<Option<S>>,
S: AsRef<str>,
[src]
pub fn add_scope<T, S>(
self,
scope: T
) -> ProjectDatabaseDocumentListCall<'a, C, A> where
T: Into<Option<S>>,
S: AsRef<str>,
Identifies the authorization scope for the method you are building.
Use this method to actively specify which scope should be used, instead 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.
If None
is specified, then all scopes will be removed and no default scope will be used either.
In that case, you have to specify your API-key using the key
parameter (see the param()
function for details).
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.
Trait Implementations
impl<'a, C, A> CallBuilder for ProjectDatabaseDocumentListCall<'a, C, A>
[src]
impl<'a, C, A> CallBuilder for ProjectDatabaseDocumentListCall<'a, C, A>
Auto Trait Implementations
impl<'a, C, A> !Send for ProjectDatabaseDocumentListCall<'a, C, A>
impl<'a, C, A> !Send for ProjectDatabaseDocumentListCall<'a, C, A>
impl<'a, C, A> !Sync for ProjectDatabaseDocumentListCall<'a, C, A>
impl<'a, C, A> !Sync for ProjectDatabaseDocumentListCall<'a, C, A>