Struct google_api_proto::google::storagetransfer::v1::TransferOptions

pub struct TransferOptions {
    pub overwrite_objects_already_existing_in_sink: bool,
    pub delete_objects_unique_in_sink: bool,
    pub delete_objects_from_source_after_transfer: bool,
    pub overwrite_when: i32,
    pub metadata_options: Option<MetadataOptions>,
}

TransferOptions define the actions to be performed on objects in a transfer.

Fields

overwrite_objects_already_existing_in_sink: bool

When to overwrite objects that already exist in the sink. The default is that only objects that are different from the source are ovewritten. If true, all objects in the sink whose name matches an object in the source are overwritten with the source object.

delete_objects_unique_in_sink: bool

Whether objects that exist only in the sink should be deleted.

Note: This option and [delete_objects_from_source_after_transfer][google.storagetransfer.v1.TransferOptions.delete_objects_from_source_after_transfer] are mutually exclusive.

delete_objects_from_source_after_transfer: bool

Whether objects should be deleted from the source after they are transferred to the sink.

Note: This option and [delete_objects_unique_in_sink][google.storagetransfer.v1.TransferOptions.delete_objects_unique_in_sink] are mutually exclusive.

overwrite_when: i32

When to overwrite objects that already exist in the sink. If not set, overwrite behavior is determined by [overwrite_objects_already_existing_in_sink][google.storagetransfer.v1.TransferOptions.overwrite_objects_already_existing_in_sink].

metadata_options: Option<MetadataOptions>

Represents the selected metadata options for a transfer job.

Implementations

impl TransferOptions

pub fn overwrite_when(&self) -> OverwriteWhen

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

pub fn set_overwrite_when(&mut self, value: OverwriteWhen)

Sets overwrite_when to the provided enum value.

Trait Implementations

impl Clone for TransferOptions

fn clone(&self) -> TransferOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TransferOptions

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

Formats the value using the given formatter.

impl Default for TransferOptions

fn default() -> Self

Returns the “default value” for a type.

impl Message for TransferOptions

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 TransferOptions

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

impl StructuralPartialEq for TransferOptions