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

#include <LifecycleRule.h>

Public Member Functions

 LifecycleRule ()
 
 LifecycleRule (const Aws::Utils::Xml::XmlNode &xmlNode)
 
LifecycleRuleoperator= (const Aws::Utils::Xml::XmlNode &xmlNode)
 
void AddToNode (Aws::Utils::Xml::XmlNode &parentNode) const
 
const LifecycleExpirationGetExpiration () const
 
bool ExpirationHasBeenSet () const
 
void SetExpiration (const LifecycleExpiration &value)
 
void SetExpiration (LifecycleExpiration &&value)
 
LifecycleRuleWithExpiration (const LifecycleExpiration &value)
 
LifecycleRuleWithExpiration (LifecycleExpiration &&value)
 
const Aws::StringGetID () const
 
bool IDHasBeenSet () const
 
void SetID (const Aws::String &value)
 
void SetID (Aws::String &&value)
 
void SetID (const char *value)
 
LifecycleRuleWithID (const Aws::String &value)
 
LifecycleRuleWithID (Aws::String &&value)
 
LifecycleRuleWithID (const char *value)
 
const LifecycleRuleFilterGetFilter () const
 
bool FilterHasBeenSet () const
 
void SetFilter (const LifecycleRuleFilter &value)
 
void SetFilter (LifecycleRuleFilter &&value)
 
LifecycleRuleWithFilter (const LifecycleRuleFilter &value)
 
LifecycleRuleWithFilter (LifecycleRuleFilter &&value)
 
const ExpirationStatusGetStatus () const
 
bool StatusHasBeenSet () const
 
void SetStatus (const ExpirationStatus &value)
 
void SetStatus (ExpirationStatus &&value)
 
LifecycleRuleWithStatus (const ExpirationStatus &value)
 
LifecycleRuleWithStatus (ExpirationStatus &&value)
 
const Aws::Vector< Transition > & GetTransitions () const
 
bool TransitionsHasBeenSet () const
 
void SetTransitions (const Aws::Vector< Transition > &value)
 
void SetTransitions (Aws::Vector< Transition > &&value)
 
LifecycleRuleWithTransitions (const Aws::Vector< Transition > &value)
 
LifecycleRuleWithTransitions (Aws::Vector< Transition > &&value)
 
LifecycleRuleAddTransitions (const Transition &value)
 
LifecycleRuleAddTransitions (Transition &&value)
 
const Aws::Vector< NoncurrentVersionTransition > & GetNoncurrentVersionTransitions () const
 
bool NoncurrentVersionTransitionsHasBeenSet () const
 
void SetNoncurrentVersionTransitions (const Aws::Vector< NoncurrentVersionTransition > &value)
 
void SetNoncurrentVersionTransitions (Aws::Vector< NoncurrentVersionTransition > &&value)
 
LifecycleRuleWithNoncurrentVersionTransitions (const Aws::Vector< NoncurrentVersionTransition > &value)
 
LifecycleRuleWithNoncurrentVersionTransitions (Aws::Vector< NoncurrentVersionTransition > &&value)
 
LifecycleRuleAddNoncurrentVersionTransitions (const NoncurrentVersionTransition &value)
 
LifecycleRuleAddNoncurrentVersionTransitions (NoncurrentVersionTransition &&value)
 
const NoncurrentVersionExpirationGetNoncurrentVersionExpiration () const
 
bool NoncurrentVersionExpirationHasBeenSet () const
 
void SetNoncurrentVersionExpiration (const NoncurrentVersionExpiration &value)
 
void SetNoncurrentVersionExpiration (NoncurrentVersionExpiration &&value)
 
LifecycleRuleWithNoncurrentVersionExpiration (const NoncurrentVersionExpiration &value)
 
LifecycleRuleWithNoncurrentVersionExpiration (NoncurrentVersionExpiration &&value)
 
const AbortIncompleteMultipartUploadGetAbortIncompleteMultipartUpload () const
 
bool AbortIncompleteMultipartUploadHasBeenSet () const
 
void SetAbortIncompleteMultipartUpload (const AbortIncompleteMultipartUpload &value)
 
void SetAbortIncompleteMultipartUpload (AbortIncompleteMultipartUpload &&value)
 
LifecycleRuleWithAbortIncompleteMultipartUpload (const AbortIncompleteMultipartUpload &value)
 
LifecycleRuleWithAbortIncompleteMultipartUpload (AbortIncompleteMultipartUpload &&value)
 

Detailed Description

A lifecycle rule for individual objects in an Amazon S3 bucket.

See Also:

AWS API Reference

Definition at line 39 of file LifecycleRule.h.

Constructor & Destructor Documentation

◆ LifecycleRule() [1/2]

Aws::S3::Model::LifecycleRule::LifecycleRule ( )

◆ LifecycleRule() [2/2]

Aws::S3::Model::LifecycleRule::LifecycleRule ( const Aws::Utils::Xml::XmlNode xmlNode)

Member Function Documentation

◆ AbortIncompleteMultipartUploadHasBeenSet()

bool Aws::S3::Model::LifecycleRule::AbortIncompleteMultipartUploadHasBeenSet ( ) const
inline

Definition at line 336 of file LifecycleRule.h.

◆ AddNoncurrentVersionTransitions() [1/2]

LifecycleRule& Aws::S3::Model::LifecycleRule::AddNoncurrentVersionTransitions ( const NoncurrentVersionTransition value)
inline

Specifies the transition rule for the lifecycle rule that describes when noncurrent objects transition to a specific storage class. If your bucket is versioning-enabled (or versioning is suspended), you can set this action to request that Amazon S3 transition noncurrent object versions to a specific storage class at a set period in the object's lifetime.

Definition at line 301 of file LifecycleRule.h.

◆ AddNoncurrentVersionTransitions() [2/2]

LifecycleRule& Aws::S3::Model::LifecycleRule::AddNoncurrentVersionTransitions ( NoncurrentVersionTransition &&  value)
inline

Specifies the transition rule for the lifecycle rule that describes when noncurrent objects transition to a specific storage class. If your bucket is versioning-enabled (or versioning is suspended), you can set this action to request that Amazon S3 transition noncurrent object versions to a specific storage class at a set period in the object's lifetime.

Definition at line 310 of file LifecycleRule.h.

◆ AddToNode()

void Aws::S3::Model::LifecycleRule::AddToNode ( Aws::Utils::Xml::XmlNode parentNode) const

◆ AddTransitions() [1/2]

LifecycleRule& Aws::S3::Model::LifecycleRule::AddTransitions ( const Transition value)
inline

Specifies when an Amazon S3 object transitions to a specified storage class.

Definition at line 231 of file LifecycleRule.h.

◆ AddTransitions() [2/2]

LifecycleRule& Aws::S3::Model::LifecycleRule::AddTransitions ( Transition &&  value)
inline

Specifies when an Amazon S3 object transitions to a specified storage class.

Definition at line 237 of file LifecycleRule.h.

◆ ExpirationHasBeenSet()

bool Aws::S3::Model::LifecycleRule::ExpirationHasBeenSet ( ) const
inline

Specifies the expiration for the lifecycle of the object in the form of date, days and, whether the object has a delete marker.

Definition at line 59 of file LifecycleRule.h.

◆ FilterHasBeenSet()

bool Aws::S3::Model::LifecycleRule::FilterHasBeenSet ( ) const
inline

Definition at line 139 of file LifecycleRule.h.

◆ GetAbortIncompleteMultipartUpload()

const AbortIncompleteMultipartUpload& Aws::S3::Model::LifecycleRule::GetAbortIncompleteMultipartUpload ( ) const
inline

Definition at line 333 of file LifecycleRule.h.

◆ GetExpiration()

const LifecycleExpiration& Aws::S3::Model::LifecycleRule::GetExpiration ( ) const
inline

Specifies the expiration for the lifecycle of the object in the form of date, days and, whether the object has a delete marker.

Definition at line 53 of file LifecycleRule.h.

◆ GetFilter()

const LifecycleRuleFilter& Aws::S3::Model::LifecycleRule::GetFilter ( ) const
inline

Definition at line 136 of file LifecycleRule.h.

◆ GetID()

const Aws::String& Aws::S3::Model::LifecycleRule::GetID ( ) const
inline

Unique identifier for the rule. The value cannot be longer than 255 characters.

Definition at line 90 of file LifecycleRule.h.

◆ GetNoncurrentVersionExpiration()

const NoncurrentVersionExpiration& Aws::S3::Model::LifecycleRule::GetNoncurrentVersionExpiration ( ) const
inline

Definition at line 314 of file LifecycleRule.h.

◆ GetNoncurrentVersionTransitions()

const Aws::Vector<NoncurrentVersionTransition>& Aws::S3::Model::LifecycleRule::GetNoncurrentVersionTransitions ( ) const
inline

Specifies the transition rule for the lifecycle rule that describes when noncurrent objects transition to a specific storage class. If your bucket is versioning-enabled (or versioning is suspended), you can set this action to request that Amazon S3 transition noncurrent object versions to a specific storage class at a set period in the object's lifetime.

Definition at line 247 of file LifecycleRule.h.

◆ GetStatus()

const ExpirationStatus& Aws::S3::Model::LifecycleRule::GetStatus ( ) const
inline

If 'Enabled', the rule is currently being applied. If 'Disabled', the rule is not currently being applied.

Definition at line 158 of file LifecycleRule.h.

◆ GetTransitions()

const Aws::Vector<Transition>& Aws::S3::Model::LifecycleRule::GetTransitions ( ) const
inline

Specifies when an Amazon S3 object transitions to a specified storage class.

Definition at line 195 of file LifecycleRule.h.

◆ IDHasBeenSet()

bool Aws::S3::Model::LifecycleRule::IDHasBeenSet ( ) const
inline

Unique identifier for the rule. The value cannot be longer than 255 characters.

Definition at line 96 of file LifecycleRule.h.

◆ NoncurrentVersionExpirationHasBeenSet()

bool Aws::S3::Model::LifecycleRule::NoncurrentVersionExpirationHasBeenSet ( ) const
inline

Definition at line 317 of file LifecycleRule.h.

◆ NoncurrentVersionTransitionsHasBeenSet()

bool Aws::S3::Model::LifecycleRule::NoncurrentVersionTransitionsHasBeenSet ( ) const
inline

Specifies the transition rule for the lifecycle rule that describes when noncurrent objects transition to a specific storage class. If your bucket is versioning-enabled (or versioning is suspended), you can set this action to request that Amazon S3 transition noncurrent object versions to a specific storage class at a set period in the object's lifetime.

Definition at line 256 of file LifecycleRule.h.

◆ operator=()

LifecycleRule& Aws::S3::Model::LifecycleRule::operator= ( const Aws::Utils::Xml::XmlNode xmlNode)

◆ SetAbortIncompleteMultipartUpload() [1/2]

void Aws::S3::Model::LifecycleRule::SetAbortIncompleteMultipartUpload ( const AbortIncompleteMultipartUpload value)
inline

Definition at line 339 of file LifecycleRule.h.

◆ SetAbortIncompleteMultipartUpload() [2/2]

void Aws::S3::Model::LifecycleRule::SetAbortIncompleteMultipartUpload ( AbortIncompleteMultipartUpload &&  value)
inline

Definition at line 342 of file LifecycleRule.h.

◆ SetExpiration() [1/2]

void Aws::S3::Model::LifecycleRule::SetExpiration ( const LifecycleExpiration value)
inline

Specifies the expiration for the lifecycle of the object in the form of date, days and, whether the object has a delete marker.

Definition at line 65 of file LifecycleRule.h.

◆ SetExpiration() [2/2]

void Aws::S3::Model::LifecycleRule::SetExpiration ( LifecycleExpiration &&  value)
inline

Specifies the expiration for the lifecycle of the object in the form of date, days and, whether the object has a delete marker.

Definition at line 71 of file LifecycleRule.h.

◆ SetFilter() [1/2]

void Aws::S3::Model::LifecycleRule::SetFilter ( const LifecycleRuleFilter value)
inline

Definition at line 142 of file LifecycleRule.h.

◆ SetFilter() [2/2]

void Aws::S3::Model::LifecycleRule::SetFilter ( LifecycleRuleFilter &&  value)
inline

Definition at line 145 of file LifecycleRule.h.

◆ SetID() [1/3]

void Aws::S3::Model::LifecycleRule::SetID ( const Aws::String value)
inline

Unique identifier for the rule. The value cannot be longer than 255 characters.

Definition at line 102 of file LifecycleRule.h.

◆ SetID() [2/3]

void Aws::S3::Model::LifecycleRule::SetID ( Aws::String &&  value)
inline

Unique identifier for the rule. The value cannot be longer than 255 characters.

Definition at line 108 of file LifecycleRule.h.

◆ SetID() [3/3]

void Aws::S3::Model::LifecycleRule::SetID ( const char *  value)
inline

Unique identifier for the rule. The value cannot be longer than 255 characters.

Definition at line 114 of file LifecycleRule.h.

◆ SetNoncurrentVersionExpiration() [1/2]

void Aws::S3::Model::LifecycleRule::SetNoncurrentVersionExpiration ( const NoncurrentVersionExpiration value)
inline

Definition at line 320 of file LifecycleRule.h.

◆ SetNoncurrentVersionExpiration() [2/2]

void Aws::S3::Model::LifecycleRule::SetNoncurrentVersionExpiration ( NoncurrentVersionExpiration &&  value)
inline

Definition at line 323 of file LifecycleRule.h.

◆ SetNoncurrentVersionTransitions() [1/2]

void Aws::S3::Model::LifecycleRule::SetNoncurrentVersionTransitions ( const Aws::Vector< NoncurrentVersionTransition > &  value)
inline

Specifies the transition rule for the lifecycle rule that describes when noncurrent objects transition to a specific storage class. If your bucket is versioning-enabled (or versioning is suspended), you can set this action to request that Amazon S3 transition noncurrent object versions to a specific storage class at a set period in the object's lifetime.

Definition at line 265 of file LifecycleRule.h.

◆ SetNoncurrentVersionTransitions() [2/2]

void Aws::S3::Model::LifecycleRule::SetNoncurrentVersionTransitions ( Aws::Vector< NoncurrentVersionTransition > &&  value)
inline

Specifies the transition rule for the lifecycle rule that describes when noncurrent objects transition to a specific storage class. If your bucket is versioning-enabled (or versioning is suspended), you can set this action to request that Amazon S3 transition noncurrent object versions to a specific storage class at a set period in the object's lifetime.

Definition at line 274 of file LifecycleRule.h.

◆ SetStatus() [1/2]

void Aws::S3::Model::LifecycleRule::SetStatus ( const ExpirationStatus value)
inline

If 'Enabled', the rule is currently being applied. If 'Disabled', the rule is not currently being applied.

Definition at line 170 of file LifecycleRule.h.

◆ SetStatus() [2/2]

void Aws::S3::Model::LifecycleRule::SetStatus ( ExpirationStatus &&  value)
inline

If 'Enabled', the rule is currently being applied. If 'Disabled', the rule is not currently being applied.

Definition at line 176 of file LifecycleRule.h.

◆ SetTransitions() [1/2]

void Aws::S3::Model::LifecycleRule::SetTransitions ( const Aws::Vector< Transition > &  value)
inline

Specifies when an Amazon S3 object transitions to a specified storage class.

Definition at line 207 of file LifecycleRule.h.

◆ SetTransitions() [2/2]

void Aws::S3::Model::LifecycleRule::SetTransitions ( Aws::Vector< Transition > &&  value)
inline

Specifies when an Amazon S3 object transitions to a specified storage class.

Definition at line 213 of file LifecycleRule.h.

◆ StatusHasBeenSet()

bool Aws::S3::Model::LifecycleRule::StatusHasBeenSet ( ) const
inline

If 'Enabled', the rule is currently being applied. If 'Disabled', the rule is not currently being applied.

Definition at line 164 of file LifecycleRule.h.

◆ TransitionsHasBeenSet()

bool Aws::S3::Model::LifecycleRule::TransitionsHasBeenSet ( ) const
inline

Specifies when an Amazon S3 object transitions to a specified storage class.

Definition at line 201 of file LifecycleRule.h.

◆ WithAbortIncompleteMultipartUpload() [1/2]

LifecycleRule& Aws::S3::Model::LifecycleRule::WithAbortIncompleteMultipartUpload ( const AbortIncompleteMultipartUpload value)
inline

Definition at line 345 of file LifecycleRule.h.

◆ WithAbortIncompleteMultipartUpload() [2/2]

LifecycleRule& Aws::S3::Model::LifecycleRule::WithAbortIncompleteMultipartUpload ( AbortIncompleteMultipartUpload &&  value)
inline

Definition at line 348 of file LifecycleRule.h.

◆ WithExpiration() [1/2]

LifecycleRule& Aws::S3::Model::LifecycleRule::WithExpiration ( const LifecycleExpiration value)
inline

Specifies the expiration for the lifecycle of the object in the form of date, days and, whether the object has a delete marker.

Definition at line 77 of file LifecycleRule.h.

◆ WithExpiration() [2/2]

LifecycleRule& Aws::S3::Model::LifecycleRule::WithExpiration ( LifecycleExpiration &&  value)
inline

Specifies the expiration for the lifecycle of the object in the form of date, days and, whether the object has a delete marker.

Definition at line 83 of file LifecycleRule.h.

◆ WithFilter() [1/2]

LifecycleRule& Aws::S3::Model::LifecycleRule::WithFilter ( const LifecycleRuleFilter value)
inline

Definition at line 148 of file LifecycleRule.h.

◆ WithFilter() [2/2]

LifecycleRule& Aws::S3::Model::LifecycleRule::WithFilter ( LifecycleRuleFilter &&  value)
inline

Definition at line 151 of file LifecycleRule.h.

◆ WithID() [1/3]

LifecycleRule& Aws::S3::Model::LifecycleRule::WithID ( const Aws::String value)
inline

Unique identifier for the rule. The value cannot be longer than 255 characters.

Definition at line 120 of file LifecycleRule.h.

◆ WithID() [2/3]

LifecycleRule& Aws::S3::Model::LifecycleRule::WithID ( Aws::String &&  value)
inline

Unique identifier for the rule. The value cannot be longer than 255 characters.

Definition at line 126 of file LifecycleRule.h.

◆ WithID() [3/3]

LifecycleRule& Aws::S3::Model::LifecycleRule::WithID ( const char *  value)
inline

Unique identifier for the rule. The value cannot be longer than 255 characters.

Definition at line 132 of file LifecycleRule.h.

◆ WithNoncurrentVersionExpiration() [1/2]

LifecycleRule& Aws::S3::Model::LifecycleRule::WithNoncurrentVersionExpiration ( const NoncurrentVersionExpiration value)
inline

Definition at line 326 of file LifecycleRule.h.

◆ WithNoncurrentVersionExpiration() [2/2]

LifecycleRule& Aws::S3::Model::LifecycleRule::WithNoncurrentVersionExpiration ( NoncurrentVersionExpiration &&  value)
inline

Definition at line 329 of file LifecycleRule.h.

◆ WithNoncurrentVersionTransitions() [1/2]

LifecycleRule& Aws::S3::Model::LifecycleRule::WithNoncurrentVersionTransitions ( const Aws::Vector< NoncurrentVersionTransition > &  value)
inline

Specifies the transition rule for the lifecycle rule that describes when noncurrent objects transition to a specific storage class. If your bucket is versioning-enabled (or versioning is suspended), you can set this action to request that Amazon S3 transition noncurrent object versions to a specific storage class at a set period in the object's lifetime.

Definition at line 283 of file LifecycleRule.h.

◆ WithNoncurrentVersionTransitions() [2/2]

LifecycleRule& Aws::S3::Model::LifecycleRule::WithNoncurrentVersionTransitions ( Aws::Vector< NoncurrentVersionTransition > &&  value)
inline

Specifies the transition rule for the lifecycle rule that describes when noncurrent objects transition to a specific storage class. If your bucket is versioning-enabled (or versioning is suspended), you can set this action to request that Amazon S3 transition noncurrent object versions to a specific storage class at a set period in the object's lifetime.

Definition at line 292 of file LifecycleRule.h.

◆ WithStatus() [1/2]

LifecycleRule& Aws::S3::Model::LifecycleRule::WithStatus ( const ExpirationStatus value)
inline

If 'Enabled', the rule is currently being applied. If 'Disabled', the rule is not currently being applied.

Definition at line 182 of file LifecycleRule.h.

◆ WithStatus() [2/2]

LifecycleRule& Aws::S3::Model::LifecycleRule::WithStatus ( ExpirationStatus &&  value)
inline

If 'Enabled', the rule is currently being applied. If 'Disabled', the rule is not currently being applied.

Definition at line 188 of file LifecycleRule.h.

◆ WithTransitions() [1/2]

LifecycleRule& Aws::S3::Model::LifecycleRule::WithTransitions ( const Aws::Vector< Transition > &  value)
inline

Specifies when an Amazon S3 object transitions to a specified storage class.

Definition at line 219 of file LifecycleRule.h.

◆ WithTransitions() [2/2]

LifecycleRule& Aws::S3::Model::LifecycleRule::WithTransitions ( Aws::Vector< Transition > &&  value)
inline

Specifies when an Amazon S3 object transitions to a specified storage class.

Definition at line 225 of file LifecycleRule.h.


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