Struct google_api_proto::google::storage::v2::RewriteObjectRequest

pub struct RewriteObjectRequest {

    pub destination_name: String,
    pub destination_bucket: String,
    pub destination_kms_key: String,
    pub destination: Option<Object>,
    pub source_bucket: String,
    pub source_object: String,
    pub source_generation: i64,
    pub rewrite_token: String,
    pub destination_predefined_acl: 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 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 copy_source_encryption_algorithm: String,
    pub copy_source_encryption_key_bytes: Bytes,
    pub copy_source_encryption_key_sha256_bytes: Bytes,
    pub common_object_request_params: Option<CommonObjectRequestParams>,
    pub object_checksums: Option<ObjectChecksums>,
}

Request message for RewriteObject. If the source object is encrypted using a Customer-Supplied Encryption Key the key information must be provided in the copy_source_encryption_algorithm, copy_source_encryption_key_bytes, and copy_source_encryption_key_sha256_bytes fields. If the destination object should be encrypted the keying information should be provided in the encryption_algorithm, encryption_key_bytes, and encryption_key_sha256_bytes fields of the common_object_request_params.customer_encryption field.

Fields

destination_name: String

Required. Immutable. The name of the destination object. See the Naming Guidelines. Example: test.txt The name field by itself does not uniquely identify a Cloud Storage object. A Cloud Storage object is uniquely identified by the tuple of (bucket, object, generation).

destination_bucket: String

Required. Immutable. The name of the bucket containing the destination object.

destination_kms_key: String

The name of the Cloud KMS key that will be used to encrypt the destination object. The Cloud KMS key must be located in same location as the object. If the parameter is not specified, the request uses the destination bucket’s default encryption key, if any, or else the Google-managed encryption key.

destination: Option<Object>

Properties of the destination, post-rewrite object. The name, bucket and kms_key fields must not be populated (these values are specified in the destination_name, destination_bucket, and destination_kms_key fields). If destination is present it will be used to construct the destination object’s metadata; otherwise the destination object’s metadata will be copied from the source object.

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

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.

destination_predefined_acl: String

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

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 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 live generation matches the given value.

if_source_generation_not_match: Option<i64>

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

copy_source_encryption_algorithm: String

The algorithm used to encrypt the source object, if any. Used if the source object was encrypted with a Customer-Supplied Encryption Key.

copy_source_encryption_key_bytes: Bytes

The raw bytes (not base64-encoded) AES-256 encryption key used to encrypt the source object, if it was encrypted with a Customer-Supplied Encryption Key.

copy_source_encryption_key_sha256_bytes: Bytes

The raw bytes (not base64-encoded) SHA256 hash of the encryption key used to encrypt the source object, if it was encrypted with a Customer-Supplied Encryption Key.

common_object_request_params: Option<CommonObjectRequestParams>

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

object_checksums: Option<ObjectChecksums>

The checksums of the complete object. This will be used to validate the destination object after rewriting.

Implementations

impl RewriteObjectRequest

pub fn if_generation_match(&self) -> i64

Returns the value of if_generation_match, or the default value if if_generation_match is unset.

pub fn if_generation_not_match(&self) -> i64

Returns the value of if_generation_not_match, or the default value if if_generation_not_match is unset.

pub fn if_metageneration_match(&self) -> i64

Returns the value of if_metageneration_match, or the default value if if_metageneration_match is unset.

pub fn if_metageneration_not_match(&self) -> i64

Returns the value of if_metageneration_not_match, or the default value if if_metageneration_not_match is unset.

pub fn if_source_generation_match(&self) -> i64

Returns the value of if_source_generation_match, or the default value if if_source_generation_match is unset.

pub fn if_source_generation_not_match(&self) -> i64

Returns the value of if_source_generation_not_match, or the default value if if_source_generation_not_match is unset.

pub fn if_source_metageneration_match(&self) -> i64

Returns the value of if_source_metageneration_match, or the default value if if_source_metageneration_match is unset.

pub fn if_source_metageneration_not_match(&self) -> i64

Returns the value of if_source_metageneration_not_match, or the default value if if_source_metageneration_not_match is unset.

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