Struct google_compute1::api::GlobalOperationWaitCall
source · pub struct GlobalOperationWaitCall<'a, S>where
S: 'a,{ /* private fields */ }
Expand description
Waits for the specified Operation resource to return as DONE
or for the request to approach the 2 minute deadline, and retrieves the specified Operation resource. This method differs from the GET
method in that it waits for no more than the default deadline (2 minutes) and then returns the current state of the operation, which might be DONE
or still in progress. This method is called on a best-effort basis. Specifically: - In uncommon cases, when the server is overloaded, the request might return before the default deadline is reached, or might return after zero seconds. - If the default deadline is reached, there is no guarantee that the operation is actually done when the method returns. Be prepared to retry if the operation is not DONE
.
A builder for the wait method supported by a globalOperation resource.
It is not used directly, but through a GlobalOperationMethods
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.global_operations().wait("project", "operation")
.doit().await;
Implementations§
source§impl<'a, S> GlobalOperationWaitCall<'a, S>
impl<'a, S> GlobalOperationWaitCall<'a, S>
sourcepub async fn doit(self) -> Result<(Response<Body>, Operation)>
pub async fn doit(self) -> Result<(Response<Body>, Operation)>
Perform the operation you have build so far.
sourcepub fn project(self, new_value: &str) -> GlobalOperationWaitCall<'a, S>
pub fn project(self, new_value: &str) -> GlobalOperationWaitCall<'a, S>
Project ID for this request.
Sets the project 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 operation(self, new_value: &str) -> GlobalOperationWaitCall<'a, S>
pub fn operation(self, new_value: &str) -> GlobalOperationWaitCall<'a, S>
Name of the Operations resource to return.
Sets the operation 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 delegate(
self,
new_value: &'a mut dyn Delegate
) -> GlobalOperationWaitCall<'a, S>
pub fn delegate( self, new_value: &'a mut dyn Delegate ) -> GlobalOperationWaitCall<'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) -> GlobalOperationWaitCall<'a, S>
pub fn param<T>(self, name: T, value: T) -> GlobalOperationWaitCall<'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”).
- userIp (query-string) - Legacy name for parameter that has been superseded by
quotaUser
.
sourcepub fn add_scope<St>(self, scope: St) -> GlobalOperationWaitCall<'a, S>
pub fn add_scope<St>(self, scope: St) -> GlobalOperationWaitCall<'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) -> GlobalOperationWaitCall<'a, S>
pub fn add_scopes<I, St>(self, scopes: I) -> GlobalOperationWaitCall<'a, S>
Identifies the authorization scope(s) for the method you are building.
See Self::add_scope()
for details.
sourcepub fn clear_scopes(self) -> GlobalOperationWaitCall<'a, S>
pub fn clear_scopes(self) -> GlobalOperationWaitCall<'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).