Struct google_storage1::ObjectDeleteCall

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

Deletes an object and its metadata. Deletions are permanent if versioning is not enabled for the bucket, or if the generation parameter is used.

A builder for the delete method supported by a object resource. It is not used directly, but through a ObjectMethods 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.objects().delete("bucket", "object")
             .user_project("vero")
             .if_metageneration_not_match("ut")
             .if_metageneration_match("sed")
             .if_generation_not_match("et")
             .if_generation_match("ipsum")
             .generation("justo")
             .doit();

Methods

impl<'a, C, A> ObjectDeleteCall<'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 bucket(self, new_value: &str) -> ObjectDeleteCall<'a, C, A>

Name of the bucket in which the object resides.

Sets the bucket 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 object(self, new_value: &str) -> ObjectDeleteCall<'a, C, A>

Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.

Sets the object 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 user_project(self, new_value: &str) -> ObjectDeleteCall<'a, C, A>

The project to be billed for this request. Required for Requester Pays buckets.

Sets the user project query property to the given value.

pub fn if_metageneration_not_match(     self,     new_value: &str ) -> ObjectDeleteCall<'a, C, A>

Makes the operation conditional on whether the object's current metageneration does not match the given value.

Sets the if metageneration not match query property to the given value.

pub fn if_metageneration_match(     self,     new_value: &str ) -> ObjectDeleteCall<'a, C, A>

Makes the operation conditional on whether the object's current metageneration matches the given value.

Sets the if metageneration match query property to the given value.

pub fn if_generation_not_match(     self,     new_value: &str ) -> ObjectDeleteCall<'a, C, A>

Makes the operation conditional on whether the object's current generation does not match the given value. If no live object exists, the precondition fails. Setting to 0 makes the operation succeed only if there is a live version of the object.

Sets the if generation not match query property to the given value.

pub fn if_generation_match(self, new_value: &str) -> ObjectDeleteCall<'a, C, A>

Makes the operation conditional on whether the object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object.

Sets the if generation match query property to the given value.

pub fn generation(self, new_value: &str) -> ObjectDeleteCall<'a, C, A>

If present, permanently deletes a specific revision of this object (as opposed to the latest version, the default).

Sets the generation query property to the given value.

pub fn delegate(self, new_value: &'a mut Delegate) -> ObjectDeleteCall<'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) -> ObjectDeleteCall<'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) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
• 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) - Deprecated. Please use quotaUser instead.
• 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) -> ObjectDeleteCall<'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 ObjectDeleteCall<'a, C, A>