Struct ObjectRetention 

#[non_exhaustive]
pub struct ObjectRetention {
    pub retain_until_time: Option<String>,
    pub retention_mode: Option<RetentionMode>,
    /* private fields */
}

Describes options for object retention update.

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.

retain_until_time: Option<String>

Required. The time when the object will be retained until. UNSET will clear the retention. Must be specified in RFC 3339 format e.g. YYYY-MM-DD’T’HH:MM:SS.SS’Z’ or YYYY-MM-DD’T’HH:MM:SS’Z’.

retention_mode: Option<RetentionMode>

Required. The retention mode of the object.

Implementations

impl ObjectRetention

pub fn new() -> Self

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

where T: Into<String>,

Sets the value of retain_until_time.

Example

let x = ObjectRetention::new().set_retain_until_time("example");

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

where T: Into<String>,

Sets or clears the value of retain_until_time.

Example

let x = ObjectRetention::new().set_or_clear_retain_until_time(Some("example"));
let x = ObjectRetention::new().set_or_clear_retain_until_time(None::<String>);

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

where T: Into<RetentionMode>,

Sets the value of retention_mode.

Example

use google_cloud_storagebatchoperations_v1::model::object_retention::RetentionMode;
let x0 = ObjectRetention::new().set_retention_mode(RetentionMode::Locked);
let x1 = ObjectRetention::new().set_retention_mode(RetentionMode::Unlocked);

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

where T: Into<RetentionMode>,

Sets or clears the value of retention_mode.

Example

use google_cloud_storagebatchoperations_v1::model::object_retention::RetentionMode;
let x0 = ObjectRetention::new().set_or_clear_retention_mode(Some(RetentionMode::Locked));
let x1 = ObjectRetention::new().set_or_clear_retention_mode(Some(RetentionMode::Unlocked));
let x_none = ObjectRetention::new().set_or_clear_retention_mode(None::<RetentionMode>);

Trait Implementations

impl Clone for ObjectRetention

fn clone(&self) -> ObjectRetention

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ObjectRetention

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

Formats the value using the given formatter.

impl Default for ObjectRetention

fn default() -> ObjectRetention

Returns the “default value” for a type.

impl Message for ObjectRetention

fn typename() -> &'static str

The typename of this message.

impl PartialEq for ObjectRetention

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