Struct google_api_proto::google::storage::v1::PatchObjectRequest

pub struct PatchObjectRequest {

    pub bucket: String,
    pub object: String,
    pub generation: i64,
    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: i32,
    pub projection: i32,
    pub metadata: Option<Object>,
    pub update_mask: Option<FieldMask>,
    pub common_object_request_params: Option<CommonObjectRequestParams>,
    pub common_request_params: Option<CommonRequestParams>,
}

Request message for PatchObject.

Fields

bucket: String

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

object: String

Required. Name of the object.

generation: i64

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

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 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.

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: i32

Apply a predefined set of access controls to this object.

projection: i32

Set of properties to return. Defaults to FULL.

metadata: Option<Object>

The Object metadata for updating.

update_mask: Option<FieldMask>

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. Not specifying a field while setting that field to a non-default value is an error.

common_object_request_params: Option<CommonObjectRequestParams>

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

common_request_params: Option<CommonRequestParams>

A set of parameters common to all Storage API requests.

Implementations

impl PatchObjectRequest

pub fn predefined_acl(&self) -> PredefinedObjectAcl

Returns the enum value of predefined_acl, or the default if the field is set to an invalid enum value.

pub fn set_predefined_acl(&mut self, value: PredefinedObjectAcl)

Sets predefined_acl to the provided enum value.

pub fn projection(&self) -> Projection

Returns the enum value of projection, or the default if the field is set to an invalid enum value.

pub fn set_projection(&mut self, value: Projection)

Sets projection to the provided enum value.

Trait Implementations

impl Clone for PatchObjectRequest

fn clone(&self) -> PatchObjectRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PatchObjectRequest

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

Formats the value using the given formatter.

impl Default for PatchObjectRequest

fn default() -> Self

Returns the “default value” for a type.

impl Message for PatchObjectRequest

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for PatchObjectRequest

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for PatchObjectRequest