pub struct FolderSearchCall<'a, S>where
S: 'a,{ /* private fields */ }Expand description
Search for folders that match specific filter criteria. search() provides an eventually consistent view of the folders a user has access to which meet the specified filter criteria. This will only return folders on which the caller has the permission resourcemanager.folders.get.
A builder for the search method supported by a folder resource.
It is not used directly, but through a FolderMethods 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.folders().search()
.query("duo")
.page_token("ipsum")
.page_size(-93)
.doit().await;Implementations§
source§impl<'a, S> FolderSearchCall<'a, S>
impl<'a, S> FolderSearchCall<'a, S>
sourcepub async fn doit(self) -> Result<(Response<Body>, SearchFoldersResponse)>
pub async fn doit(self) -> Result<(Response<Body>, SearchFoldersResponse)>
Perform the operation you have build so far.
sourcepub fn query(self, new_value: &str) -> FolderSearchCall<'a, S>
pub fn query(self, new_value: &str) -> FolderSearchCall<'a, S>
Optional. Search criteria used to select the folders to return. If no search criteria is specified then all accessible folders will be returned. Query expressions can be used to restrict results based upon displayName, state and parent, where the operators = (:) NOT, AND and OR can be used along with the suffix wildcard symbol *. The displayName field in a query expression should use escaped quotes for values that include whitespace to prevent unexpected behavior. | Field | Description | |-------------------------|----------------------------------------| | displayName | Filters by displayName. | | parent | Filters by parent (for example: folders/123). | | state, lifecycleState | Filters by state. | Some example queries are: * Query displayName=Test* returns Folder resources whose display name starts with “Test”. * Query state=ACTIVE returns Folder resources with state set to ACTIVE. * Query parent=folders/123 returns Folder resources that have folders/123 as a parent resource. * Query parent=folders/123 AND state=ACTIVE returns active Folder resources that have folders/123 as a parent resource. * Query displayName=\\"Test String\\" returns Folder resources with display names that include both “Test” and “String”.
Sets the query query property to the given value.
sourcepub fn page_token(self, new_value: &str) -> FolderSearchCall<'a, S>
pub fn page_token(self, new_value: &str) -> FolderSearchCall<'a, S>
Optional. A pagination token returned from a previous call to SearchFolders that indicates from where search should continue.
Sets the page token query property to the given value.
sourcepub fn page_size(self, new_value: i32) -> FolderSearchCall<'a, S>
pub fn page_size(self, new_value: i32) -> FolderSearchCall<'a, S>
Optional. The maximum number of folders to return in the response. The server can return fewer folders than requested. If unspecified, server picks an appropriate default.
Sets the page size query property to the given value.
sourcepub fn delegate(
self,
new_value: &'a mut dyn Delegate
) -> FolderSearchCall<'a, S>
pub fn delegate( self, new_value: &'a mut dyn Delegate ) -> FolderSearchCall<'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) -> FolderSearchCall<'a, S>
pub fn param<T>(self, name: T, value: T) -> FolderSearchCall<'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) -> FolderSearchCall<'a, S>
pub fn add_scope<St>(self, scope: St) -> FolderSearchCall<'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) -> FolderSearchCall<'a, S>
pub fn add_scopes<I, St>(self, scopes: I) -> FolderSearchCall<'a, S>
Identifies the authorization scope(s) for the method you are building.
See Self::add_scope() for details.
sourcepub fn clear_scopes(self) -> FolderSearchCall<'a, S>
pub fn clear_scopes(self) -> FolderSearchCall<'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).