Struct google_appstate1::StateDeleteCall

pub struct StateDeleteCall<'a, C, A>
where
    C: 'a,
    A: 'a,
{ /* private fields */ }

Deletes a key and the data associated with it. The key is removed and no longer counts against the key quota. Note that since this method is not safe in the face of concurrent modifications, it should only be used for development and testing purposes. Invoking this method in shipping code can result in data loss and data corruption.

A builder for the delete method supported by a state resource. It is not used directly, but through a StateMethods 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.states().delete(-63)
             .doit();

Implementations

impl<'a, C, A> StateDeleteCall<'a, C, A>

where C: BorrowMut<Client>, A: GetToken,

pub fn doit(self) -> Result<Response>

Perform the operation you have build so far.

pub fn state_key(self, new_value: i32) -> StateDeleteCall<'a, C, A>

The key for the data to be retrieved.

Sets the state key 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 delegate( self, new_value: &'a mut dyn Delegate, ) -> StateDeleteCall<'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) -> StateDeleteCall<'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

• 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. Overrides userIp if both are provided.
• 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.
• prettyPrint (query-boolean) - Returns response with indentations and line breaks.
• userIp (query-string) - IP address of the site where the request originates. Use this if you want to enforce per-user limits.
• fields (query-string) - Selector specifying which fields to include in a partial response.
• alt (query-string) - Data format for the response.

pub fn add_scope<T, S>(self, scope: T) -> StateDeleteCall<'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::Full.

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 StateDeleteCall<'a, C, A>