Struct google_api_proto::google::storage::v1::RewriteObjectRequest

pub struct RewriteObjectRequest {

    pub destination_bucket: String,
    pub destination_object: String,
    pub destination_kms_key_name: String,
    pub destination_predefined_acl: i32,
    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 if_source_generation_match: Option<i64>,
    pub if_source_generation_not_match: Option<i64>,
    pub if_source_metageneration_match: Option<i64>,
    pub if_source_metageneration_not_match: Option<i64>,
    pub max_bytes_rewritten_per_call: i64,
    pub projection: i32,
    pub rewrite_token: String,
    pub source_bucket: String,
    pub source_object: String,
    pub source_generation: i64,
    pub object: Option<Object>,
    pub copy_source_encryption_algorithm: String,
    pub copy_source_encryption_key: String,
    pub copy_source_encryption_key_sha256: String,
    pub common_object_request_params: Option<CommonObjectRequestParams>,
    pub common_request_params: Option<CommonRequestParams>,
}

Request message for RewriteObject.

Fields

destination_bucket: String

Required. Name of the bucket in which to store the new object. Overrides the provided object metadata’s bucket value, if any.

destination_object: String

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

destination_kms_key_name: String

Resource name of the Cloud KMS key, of the form projects/my-project/locations/my-location/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.

destination_predefined_acl: i32

Apply a predefined set of access controls to the destination 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 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 destination object’s current metageneration matches the given value.

if_metageneration_not_match: Option<i64>

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

if_source_generation_match: Option<i64>

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

if_source_generation_not_match: Option<i64>

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

if_source_metageneration_match: Option<i64>

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

if_source_metageneration_not_match: Option<i64>

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

max_bytes_rewritten_per_call: i64

The maximum number of bytes that will be rewritten per rewrite request. Most callers shouldn’t need to specify this parameter - it is primarily in place to support testing. If specified the value must be an integral multiple of 1 MiB (1048576). Also, this only applies to requests where the source and destination span locations and/or storage classes. Finally, this value must not change across rewrite calls else you’ll get an error that the rewriteToken is invalid.

projection: i32

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

rewrite_token: String

Include this field (from the previous rewrite response) on each rewrite request after the first one, until the rewrite response ‘done’ flag is true. Calls that provide a rewriteToken can omit all other request fields, but if included those fields must match the values provided in the first rewrite request.

source_bucket: String

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

source_object: String

Required. Name of the source object.

source_generation: i64

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

object: Option<Object>

Properties of the destination, post-rewrite object.

copy_source_encryption_algorithm: String

The algorithm used to encrypt the source object, if any.

copy_source_encryption_key: String

The encryption key used to encrypt the source object, if any.

copy_source_encryption_key_sha256: String

The SHA-256 hash of the key used to encrypt the source object, if any.

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 RewriteObjectRequest

pub fn destination_predefined_acl(&self) -> PredefinedObjectAcl

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

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

Sets destination_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 RewriteObjectRequest

fn clone(&self) -> RewriteObjectRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RewriteObjectRequest

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

Formats the value using the given formatter.

impl Default for RewriteObjectRequest

fn default() -> Self

Returns the “default value” for a type.

impl Message for RewriteObjectRequest

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 RewriteObjectRequest

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