Struct UpdateObjectRequest

#[non_exhaustive]
pub struct UpdateObjectRequest {
    pub object: Option<Object>,
    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 predefined_acl: String,
    pub update_mask: Option<FieldMask>,
    pub common_object_request_params: Option<CommonObjectRequestParams>,
    pub override_unlocked_retention: bool,
    /* private fields */
}

Request message for UpdateObject.

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.

object: Option<Object>

Required. The object to update. The object’s bucket and name fields are used to identify the object to update. If present, the object’s generation field selects a specific revision of this object whose metadata should be updated. Otherwise, assumes the live version of the object.

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.

predefined_acl: String

Optional. Apply a predefined set of access controls to this object. Valid values are “authenticatedRead”, “bucketOwnerFullControl”, “bucketOwnerRead”, “private”, “projectPrivate”, or “publicRead”.

update_mask: Option<FieldMask>

Required. List of fields to be updated.

To specify ALL fields, equivalent to the JSON API’s “update” function, specify a single field with the value *. Note: not recommended. If a new field is introduced at a later time, an older client updating with the * may accidentally reset the new field’s value.

Not specifying any fields is an error.

common_object_request_params: Option<CommonObjectRequestParams>

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

override_unlocked_retention: bool

Optional. Overrides the unlocked retention config on the object.

Implementations

impl UpdateObjectRequest

pub fn new() -> Self

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

where T: Into<Object>,

Sets the value of object.

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

where T: Into<Object>,

Sets or clears the value of object.

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

where T: Into<i64>,

Sets the value of if_generation_match.

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.

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

where T: Into<i64>,

Sets the value of if_generation_not_match.

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.

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

where T: Into<i64>,

Sets the value of if_metageneration_match.

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.

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

where T: Into<i64>,

Sets the value of if_metageneration_not_match.

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.

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

Sets the value of predefined_acl.

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

where T: Into<FieldMask>,

Sets the value of update_mask.

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

where T: Into<FieldMask>,

Sets or clears the value of update_mask.

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

where T: Into<CommonObjectRequestParams>,

Sets the value of common_object_request_params.

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.

pub fn set_override_unlocked_retention<T: Into<bool>>(self, v: T) -> Self

Sets the value of override_unlocked_retention.

Trait Implementations

impl Clone for UpdateObjectRequest

fn clone(&self) -> UpdateObjectRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UpdateObjectRequest

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

Formats the value using the given formatter.

impl Default for UpdateObjectRequest

fn default() -> UpdateObjectRequest

Returns the “default value” for a type.

impl Message for UpdateObjectRequest

fn typename() -> &'static str

The typename of this message.

impl PartialEq for UpdateObjectRequest

fn eq(&self, other: &UpdateObjectRequest) -> 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 UpdateObjectRequest