Struct aws_sdk_s3control::model::S3Retention

#[non_exhaustive]
pub struct S3Retention { /* private fields */ }

Contains the S3 Object Lock retention mode to be applied to all objects in the S3 Batch Operations job. If you don't provide Mode and RetainUntilDate data types in your operation, you will remove the retention from your objects. For more information, see Using S3 Object Lock retention with S3 Batch Operations in the Amazon S3 User Guide.

Implementations

impl S3Retention

pub fn retain_until_date(&self) -> Option<&DateTime>

The date when the applied Object Lock retention will expire on all objects set by the Batch Operations job.

pub fn mode(&self) -> Option<&S3ObjectLockRetentionMode>

The Object Lock retention mode to be applied to all objects in the Batch Operations job.

impl S3Retention

pub fn builder() -> Builder

Creates a new builder-style object to manufacture S3Retention.

Examples found in repository

src/xml_deser.rs (line 6006)

pub fn deser_structure_crate_model_s3_retention(
    decoder: &mut aws_smithy_xml::decode::ScopedDecoder,
) -> Result<crate::model::S3Retention, aws_smithy_xml::decode::XmlDecodeError> {
    #[allow(unused_mut)]
    let mut builder = crate::model::S3Retention::builder();
    while let Some(mut tag) = decoder.next_tag() {
        match tag.start_el() {
            s if s.matches("RetainUntilDate") /* RetainUntilDate com.amazonaws.s3control#S3Retention$RetainUntilDate */ =>  {
                let var_283 =
                    Some(
                        aws_smithy_types::DateTime::from_str(
                            aws_smithy_xml::decode::try_data(&mut tag)?.as_ref()
                            , aws_smithy_types::date_time::Format::DateTime
                        )
                        .map_err(|_|aws_smithy_xml::decode::XmlDecodeError::custom("expected (timestamp: `com.amazonaws.s3control#TimeStamp`)"))
                        ?
                    )
                ;
                builder = builder.set_retain_until_date(var_283);
            }
            ,
            s if s.matches("Mode") /* Mode com.amazonaws.s3control#S3Retention$Mode */ =>  {
                let var_284 =
                    Some(
                        Result::<crate::model::S3ObjectLockRetentionMode, aws_smithy_xml::decode::XmlDecodeError>::Ok(
                            crate::model::S3ObjectLockRetentionMode::from(
                                aws_smithy_xml::decode::try_data(&mut tag)?.as_ref()
                            )
                        )
                        ?
                    )
                ;
                builder = builder.set_mode(var_284);
            }
            ,
            _ => {}
        }
    }
    Ok(builder.build())
}

Trait Implementations

impl Clone for S3Retention

fn clone(&self) -> S3Retention

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for S3Retention

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

Formats the value using the given formatter.

impl PartialEq<S3Retention> for S3Retention

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