Struct google_storage1::api::ObjectCopyCall[−][src]

pub struct ObjectCopyCall<'a> { /* fields omitted */ }

Expand description

Copies a source object to a destination object. Optionally overrides metadata.

A builder for the copy method supported by a object resource. It is not used directly, but through a ObjectMethods instance.

Example

Instantiate a resource method builder

use storage1::api::Object;
 
// As the method needs a request, you would usually fill it with the desired information
// into the respective structure. Some of the parts shown here might not be applicable !
// Values shown here are possibly random and not representative !
let mut req = Object::default();
 
// 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().copy(req, "sourceBucket", "sourceObject", "destinationBucket", "destinationObject")
             .user_project("amet")
             .source_generation("ut")
             .provisional_user_project("At")
             .projection("sit")
             .if_source_metageneration_not_match("vero")
             .if_source_metageneration_match("duo")
             .if_source_generation_not_match("sadipscing")
             .if_source_generation_match("ut")
             .if_metageneration_not_match("rebum.")
             .if_metageneration_match("duo")
             .if_generation_not_match("kasd")
             .if_generation_match("sadipscing")
             .destination_predefined_acl("tempor")
             .destination_kms_key_name("sea")
             .doit().await;

Implementations

impl<'a> ObjectCopyCall<'a>

pub async fn doit(self) -> Result<(Response<Body>, Object )>

Perform the operation you have build so far.

pub fn request(self, new_value: Object) -> ObjectCopyCall<'a>

Sets the request 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 source_bucket(self, new_value: &str) -> ObjectCopyCall<'a>

Name of the bucket in which to find the source object.

Sets the source 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 source_object(self, new_value: &str) -> ObjectCopyCall<'a>

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

Sets the source 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 destination_bucket(self, new_value: &str) -> ObjectCopyCall<'a>

Name of the bucket in which to store the new object. Overrides the provided object metadata’s bucket value, if any.For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.

Sets the destination 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 destination_object(self, new_value: &str) -> ObjectCopyCall<'a>

Name of the new object. Required when the object metadata is not otherwise provided. Overrides the object metadata’s name value, if any.

Sets the destination 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) -> ObjectCopyCall<'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 source_generation(self, new_value: &str) -> ObjectCopyCall<'a>

If present, selects a specific revision of the source object (as opposed to the latest version, the default).

Sets the source generation query property to the given value.

pub fn provisional_user_project(self, new_value: &str) -> ObjectCopyCall<'a>

The project to be billed for this request if the target bucket is requester-pays bucket.

Sets the provisional user project query property to the given value.

pub fn projection(self, new_value: &str) -> ObjectCopyCall<'a>

Set of properties to return. Defaults to noAcl, unless the object resource specifies the acl property, when it defaults to full.

Sets the projection query property to the given value.

pub fn if_source_metageneration_not_match(
self,
new_value: &str
) -> ObjectCopyCall<'a>

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

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

pub fn if_source_metageneration_match(
self,
new_value: &str
) -> ObjectCopyCall<'a>

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

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

pub fn if_source_generation_not_match(
self,
new_value: &str
) -> ObjectCopyCall<'a>

Makes the operation conditional on whether the source object’s current generation does not match the given value.

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

pub fn if_source_generation_match(self, new_value: &str) -> ObjectCopyCall<'a>

Makes the operation conditional on whether the source object’s current generation matches the given value.

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

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

Makes the operation conditional on whether the destination 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) -> ObjectCopyCall<'a>

Makes the operation conditional on whether the destination 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) -> ObjectCopyCall<'a>

Makes the operation conditional on whether the destination 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) -> ObjectCopyCall<'a>

Makes the operation conditional on whether the destination 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 destination_predefined_acl(self, new_value: &str) -> ObjectCopyCall<'a>

Apply a predefined set of access controls to the destination object.

Sets the destination predefined acl query property to the given value.

pub fn destination_kms_key_name(self, new_value: &str) -> ObjectCopyCall<'a>

Resource name of the Cloud KMS key, of the form projects/my-project/locations/global/keyRings/my-kr/cryptoKeys/my-key, that will be used to encrypt the object. Overrides the object metadata’s kms_key_name value, if any.

Sets the destination kms key name query property to the given value.

pub fn delegate(self, new_value: &'a mut dyn Delegate) -> ObjectCopyCall<'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) -> ObjectCopyCall<'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 parameters which have their own setter method. If done anyway, the request will fail.

Additional Parameters

alt (query-string) - Data format for the response.
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) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
userIp (query-string) - Deprecated. Please use quotaUser instead.

pub fn add_scope<T, S>(self, scope: T) -> ObjectCopyCall<'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> CallBuilder for ObjectCopyCall<'a>

Auto Trait Implementations

impl<'a> !RefUnwindSafe for ObjectCopyCall<'a>

impl<'a> Send for ObjectCopyCall<'a>

impl<'a> !Sync for ObjectCopyCall<'a>

impl<'a> Unpin for ObjectCopyCall<'a>

impl<'a> !UnwindSafe for ObjectCopyCall<'a>

Blanket Implementations

impl<T> Any for T where
T: 'static + ?Sized,

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
T: ?Sized,

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
T: ?Sized,

pub fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

pub fn from(t: T) -> T

Performs the conversion.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T where
U: From<T>,

pub fn into(self) -> U

Performs the conversion.

impl<T, U> TryFrom<U> for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.