Struct RetentionPolicy 

#[non_exhaustive]
pub struct RetentionPolicy {
    pub effective_time: Option<Timestamp>,
    pub is_locked: bool,
    pub retention_duration: Option<Duration>,
    /* private fields */
}

Retention policy properties of a bucket.

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.

effective_time: Option<Timestamp>

Optional. Server-determined value that indicates the time from which policy was enforced and effective.

is_locked: bool

Optional. Once locked, an object retention policy cannot be modified.

retention_duration: Option<Duration>

Optional. The duration that objects need to be retained. Retention duration must be greater than zero and less than 100 years. Note that enforcement of retention periods less than a day is not guaranteed. Such periods should only be used for testing purposes. Any nanos value specified is rounded down to the nearest second.

Implementations

impl RetentionPolicy

pub fn new() -> Self

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

where T: Into<Timestamp>,

Sets the value of effective_time.

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

where T: Into<Timestamp>,

Sets or clears the value of effective_time.

pub fn set_is_locked<T: Into<bool>>(self, v: T) -> Self

Sets the value of is_locked.

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

where T: Into<Duration>,

Sets the value of retention_duration.

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

where T: Into<Duration>,

Sets or clears the value of retention_duration.

Trait Implementations

impl Clone for RetentionPolicy

fn clone(&self) -> RetentionPolicy

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RetentionPolicy

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

Formats the value using the given formatter.

impl Default for RetentionPolicy

fn default() -> RetentionPolicy

Returns the “default value” for a type.

impl Message for RetentionPolicy

fn typename() -> &'static str

The typename of this message.

impl PartialEq for RetentionPolicy

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