Struct RestoreObjectRequest 

#[non_exhaustive]
pub struct RestoreObjectRequest {
    pub bucket: String,
    pub object: String,
    pub generation: i64,
    pub restore_token: String,
    pub if_generation_match: Option<i64>,
    pub if_generation_not_match: Option<i64>,
    pub if_metageneration_match: Option<i64>,
    pub if_metageneration_not_match: Option<i64>,
    pub copy_source_acl: Option<bool>,
    pub common_object_request_params: Option<CommonObjectRequestParams>,
    /* private fields */
}

Request message for RestoreObject. bucket, object, and generation must be set.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

bucket: String

Required. Name of the bucket in which the object resides.

object: String

Required. The name of the object to restore.

generation: i64

Required. The specific revision of the object to restore.

restore_token: String

Optional. Restore token used to differentiate soft-deleted objects with the same name and generation. Only applicable for hierarchical namespace buckets. This parameter is optional, and is only required in the rare case when there are multiple soft-deleted objects with the same name and generation.

if_generation_match: Option<i64>

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.

if_generation_not_match: Option<i64>

Makes the operation conditional on whether the object’s live 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.

if_metageneration_match: Option<i64>

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

if_metageneration_not_match: Option<i64>

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

copy_source_acl: Option<bool>

If false or unset, the bucket’s default object ACL is used. If true, copy the source object’s access controls. Return an error if bucket has UBLA enabled.

common_object_request_params: Option<CommonObjectRequestParams>

Optional. A set of parameters common to Storage API requests concerning an object.

Implementations

impl RestoreObjectRequest

pub fn new() -> Self

pub fn set_bucket<T: Into<String>>(self, v: T) -> Self

Sets the value of bucket.

Example

let x = RestoreObjectRequest::new().set_bucket("example");

pub fn set_object<T: Into<String>>(self, v: T) -> Self

Sets the value of object.

Example

let x = RestoreObjectRequest::new().set_object("example");

pub fn set_generation<T: Into<i64>>(self, v: T) -> Self

Sets the value of generation.

Example

let x = RestoreObjectRequest::new().set_generation(42);

pub fn set_restore_token<T: Into<String>>(self, v: T) -> Self

Sets the value of restore_token.

Example

let x = RestoreObjectRequest::new().set_restore_token("example");

pub fn set_if_generation_match<T>(self, v: T) -> Self

where T: Into<i64>,

Sets the value of if_generation_match.

Example

let x = RestoreObjectRequest::new().set_if_generation_match(42);

pub fn set_or_clear_if_generation_match<T>(self, v: Option<T>) -> Self

where T: Into<i64>,

Sets or clears the value of if_generation_match.

Example

let x = RestoreObjectRequest::new().set_or_clear_if_generation_match(Some(42));
let x = RestoreObjectRequest::new().set_or_clear_if_generation_match(None::<i32>);

pub fn set_if_generation_not_match<T>(self, v: T) -> Self

where T: Into<i64>,

Sets the value of if_generation_not_match.

Example

let x = RestoreObjectRequest::new().set_if_generation_not_match(42);

pub fn set_or_clear_if_generation_not_match<T>(self, v: Option<T>) -> Self

where T: Into<i64>,

Sets or clears the value of if_generation_not_match.

Example

let x = RestoreObjectRequest::new().set_or_clear_if_generation_not_match(Some(42));
let x = RestoreObjectRequest::new().set_or_clear_if_generation_not_match(None::<i32>);

pub fn set_if_metageneration_match<T>(self, v: T) -> Self

where T: Into<i64>,

Sets the value of if_metageneration_match.

Example

let x = RestoreObjectRequest::new().set_if_metageneration_match(42);

pub fn set_or_clear_if_metageneration_match<T>(self, v: Option<T>) -> Self

where T: Into<i64>,

Sets or clears the value of if_metageneration_match.

Example

let x = RestoreObjectRequest::new().set_or_clear_if_metageneration_match(Some(42));
let x = RestoreObjectRequest::new().set_or_clear_if_metageneration_match(None::<i32>);

pub fn set_if_metageneration_not_match<T>(self, v: T) -> Self

where T: Into<i64>,

Sets the value of if_metageneration_not_match.

Example

let x = RestoreObjectRequest::new().set_if_metageneration_not_match(42);

pub fn set_or_clear_if_metageneration_not_match<T>(self, v: Option<T>) -> Self

where T: Into<i64>,

Sets or clears the value of if_metageneration_not_match.

Example

let x = RestoreObjectRequest::new().set_or_clear_if_metageneration_not_match(Some(42));
let x = RestoreObjectRequest::new().set_or_clear_if_metageneration_not_match(None::<i32>);

pub fn set_copy_source_acl<T>(self, v: T) -> Self

where T: Into<bool>,

Sets the value of copy_source_acl.

Example

let x = RestoreObjectRequest::new().set_copy_source_acl(true);

pub fn set_or_clear_copy_source_acl<T>(self, v: Option<T>) -> Self

where T: Into<bool>,

Sets or clears the value of copy_source_acl.

Example

let x = RestoreObjectRequest::new().set_or_clear_copy_source_acl(Some(false));
let x = RestoreObjectRequest::new().set_or_clear_copy_source_acl(None::<bool>);

pub fn set_common_object_request_params<T>(self, v: T) -> Self

where T: Into<CommonObjectRequestParams>,

Sets the value of common_object_request_params.

Example

use google_cloud_storage::model::CommonObjectRequestParams;
let x = RestoreObjectRequest::new().set_common_object_request_params(CommonObjectRequestParams::default()/* use setters */);

pub fn set_or_clear_common_object_request_params<T>(self, v: Option<T>) -> Self

where T: Into<CommonObjectRequestParams>,

Sets or clears the value of common_object_request_params.

Example

use google_cloud_storage::model::CommonObjectRequestParams;
let x = RestoreObjectRequest::new().set_or_clear_common_object_request_params(Some(CommonObjectRequestParams::default()/* use setters */));
let x = RestoreObjectRequest::new().set_or_clear_common_object_request_params(None::<CommonObjectRequestParams>);

Trait Implementations

impl Clone for RestoreObjectRequest

fn clone(&self) -> RestoreObjectRequest

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RestoreObjectRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for RestoreObjectRequest

fn default() -> RestoreObjectRequest

Returns the “default value” for a type.

impl Message for RestoreObjectRequest

fn typename() -> &'static str

The typename of this message.

impl PartialEq for RestoreObjectRequest

fn eq(&self, other: &RestoreObjectRequest) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for RestoreObjectRequest