AWS SDK for C++  1.8.95
AWS SDK for C++
Public Member Functions | List of all members
Aws::S3Control::Model::S3Retention Class Reference

#include <S3Retention.h>

Public Member Functions

 S3Retention ()
 
 S3Retention (const Aws::Utils::Xml::XmlNode &xmlNode)
 
S3Retentionoperator= (const Aws::Utils::Xml::XmlNode &xmlNode)
 
void AddToNode (Aws::Utils::Xml::XmlNode &parentNode) const
 
const Aws::Utils::DateTimeGetRetainUntilDate () const
 
bool RetainUntilDateHasBeenSet () const
 
void SetRetainUntilDate (const Aws::Utils::DateTime &value)
 
void SetRetainUntilDate (Aws::Utils::DateTime &&value)
 
S3RetentionWithRetainUntilDate (const Aws::Utils::DateTime &value)
 
S3RetentionWithRetainUntilDate (Aws::Utils::DateTime &&value)
 
const S3ObjectLockRetentionModeGetMode () const
 
bool ModeHasBeenSet () const
 
void SetMode (const S3ObjectLockRetentionMode &value)
 
void SetMode (S3ObjectLockRetentionMode &&value)
 
S3RetentionWithMode (const S3ObjectLockRetentionMode &value)
 
S3RetentionWithMode (S3ObjectLockRetentionMode &&value)
 

Detailed Description

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 Simple Storage Service Developer Guide.

See Also:

AWS API Reference

Definition at line 37 of file S3Retention.h.

Constructor & Destructor Documentation

◆ S3Retention() [1/2]

Aws::S3Control::Model::S3Retention::S3Retention ( )

◆ S3Retention() [2/2]

Aws::S3Control::Model::S3Retention::S3Retention ( const Aws::Utils::Xml::XmlNode xmlNode)

Member Function Documentation

◆ AddToNode()

void Aws::S3Control::Model::S3Retention::AddToNode ( Aws::Utils::Xml::XmlNode parentNode) const

◆ GetMode()

const S3ObjectLockRetentionMode& Aws::S3Control::Model::S3Retention::GetMode ( ) const
inline

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

Definition at line 88 of file S3Retention.h.

◆ GetRetainUntilDate()

const Aws::Utils::DateTime& Aws::S3Control::Model::S3Retention::GetRetainUntilDate ( ) const
inline

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

Definition at line 51 of file S3Retention.h.

◆ ModeHasBeenSet()

bool Aws::S3Control::Model::S3Retention::ModeHasBeenSet ( ) const
inline

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

Definition at line 94 of file S3Retention.h.

◆ operator=()

S3Retention& Aws::S3Control::Model::S3Retention::operator= ( const Aws::Utils::Xml::XmlNode xmlNode)

◆ RetainUntilDateHasBeenSet()

bool Aws::S3Control::Model::S3Retention::RetainUntilDateHasBeenSet ( ) const
inline

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

Definition at line 57 of file S3Retention.h.

◆ SetMode() [1/2]

void Aws::S3Control::Model::S3Retention::SetMode ( const S3ObjectLockRetentionMode value)
inline

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

Definition at line 100 of file S3Retention.h.

◆ SetMode() [2/2]

void Aws::S3Control::Model::S3Retention::SetMode ( S3ObjectLockRetentionMode &&  value)
inline

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

Definition at line 106 of file S3Retention.h.

◆ SetRetainUntilDate() [1/2]

void Aws::S3Control::Model::S3Retention::SetRetainUntilDate ( const Aws::Utils::DateTime value)
inline

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

Definition at line 63 of file S3Retention.h.

◆ SetRetainUntilDate() [2/2]

void Aws::S3Control::Model::S3Retention::SetRetainUntilDate ( Aws::Utils::DateTime &&  value)
inline

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

Definition at line 69 of file S3Retention.h.

◆ WithMode() [1/2]

S3Retention& Aws::S3Control::Model::S3Retention::WithMode ( const S3ObjectLockRetentionMode value)
inline

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

Definition at line 112 of file S3Retention.h.

◆ WithMode() [2/2]

S3Retention& Aws::S3Control::Model::S3Retention::WithMode ( S3ObjectLockRetentionMode &&  value)
inline

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

Definition at line 118 of file S3Retention.h.

◆ WithRetainUntilDate() [1/2]

S3Retention& Aws::S3Control::Model::S3Retention::WithRetainUntilDate ( const Aws::Utils::DateTime value)
inline

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

Definition at line 75 of file S3Retention.h.

◆ WithRetainUntilDate() [2/2]

S3Retention& Aws::S3Control::Model::S3Retention::WithRetainUntilDate ( Aws::Utils::DateTime &&  value)
inline

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

Definition at line 81 of file S3Retention.h.


The documentation for this class was generated from the following file: