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

#include <S3SetObjectRetentionOperation.h>

Public Member Functions

 S3SetObjectRetentionOperation ()
 
 S3SetObjectRetentionOperation (const Aws::Utils::Xml::XmlNode &xmlNode)
 
S3SetObjectRetentionOperationoperator= (const Aws::Utils::Xml::XmlNode &xmlNode)
 
void AddToNode (Aws::Utils::Xml::XmlNode &parentNode) const
 
bool GetBypassGovernanceRetention () const
 
bool BypassGovernanceRetentionHasBeenSet () const
 
void SetBypassGovernanceRetention (bool value)
 
S3SetObjectRetentionOperationWithBypassGovernanceRetention (bool value)
 
const S3RetentionGetRetention () const
 
bool RetentionHasBeenSet () const
 
void SetRetention (const S3Retention &value)
 
void SetRetention (S3Retention &&value)
 
S3SetObjectRetentionOperationWithRetention (const S3Retention &value)
 
S3SetObjectRetentionOperationWithRetention (S3Retention &&value)
 

Detailed Description

Contains the configuration parameters for the Object Lock retention action for an S3 Batch Operations job. Batch Operations passes each value through to the underlying PutObjectRetention API. 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 35 of file S3SetObjectRetentionOperation.h.

Constructor & Destructor Documentation

◆ S3SetObjectRetentionOperation() [1/2]

Aws::S3Control::Model::S3SetObjectRetentionOperation::S3SetObjectRetentionOperation ( )

◆ S3SetObjectRetentionOperation() [2/2]

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

Member Function Documentation

◆ AddToNode()

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

◆ BypassGovernanceRetentionHasBeenSet()

bool Aws::S3Control::Model::S3SetObjectRetentionOperation::BypassGovernanceRetentionHasBeenSet ( ) const
inline

Indicates if the action should be applied to objects in the Batch Operations job even if they have Object Lock GOVERNANCE type in place.

Definition at line 55 of file S3SetObjectRetentionOperation.h.

◆ GetBypassGovernanceRetention()

bool Aws::S3Control::Model::S3SetObjectRetentionOperation::GetBypassGovernanceRetention ( ) const
inline

Indicates if the action should be applied to objects in the Batch Operations job even if they have Object Lock GOVERNANCE type in place.

Definition at line 49 of file S3SetObjectRetentionOperation.h.

◆ GetRetention()

const S3Retention& Aws::S3Control::Model::S3SetObjectRetentionOperation::GetRetention ( ) const
inline

Contains the Object Lock retention mode to be applied to all objects in the Batch Operations job. For more information, see Using S3 Object Lock retention with S3 Batch Operations in the Amazon Simple Storage Service Developer Guide.

Definition at line 77 of file S3SetObjectRetentionOperation.h.

◆ operator=()

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

◆ RetentionHasBeenSet()

bool Aws::S3Control::Model::S3SetObjectRetentionOperation::RetentionHasBeenSet ( ) const
inline

Contains the Object Lock retention mode to be applied to all objects in the Batch Operations job. For more information, see Using S3 Object Lock retention with S3 Batch Operations in the Amazon Simple Storage Service Developer Guide.

Definition at line 86 of file S3SetObjectRetentionOperation.h.

◆ SetBypassGovernanceRetention()

void Aws::S3Control::Model::S3SetObjectRetentionOperation::SetBypassGovernanceRetention ( bool  value)
inline

Indicates if the action should be applied to objects in the Batch Operations job even if they have Object Lock GOVERNANCE type in place.

Definition at line 61 of file S3SetObjectRetentionOperation.h.

◆ SetRetention() [1/2]

void Aws::S3Control::Model::S3SetObjectRetentionOperation::SetRetention ( const S3Retention value)
inline

Contains the Object Lock retention mode to be applied to all objects in the Batch Operations job. For more information, see Using S3 Object Lock retention with S3 Batch Operations in the Amazon Simple Storage Service Developer Guide.

Definition at line 95 of file S3SetObjectRetentionOperation.h.

◆ SetRetention() [2/2]

void Aws::S3Control::Model::S3SetObjectRetentionOperation::SetRetention ( S3Retention &&  value)
inline

Contains the Object Lock retention mode to be applied to all objects in the Batch Operations job. For more information, see Using S3 Object Lock retention with S3 Batch Operations in the Amazon Simple Storage Service Developer Guide.

Definition at line 104 of file S3SetObjectRetentionOperation.h.

◆ WithBypassGovernanceRetention()

S3SetObjectRetentionOperation& Aws::S3Control::Model::S3SetObjectRetentionOperation::WithBypassGovernanceRetention ( bool  value)
inline

Indicates if the action should be applied to objects in the Batch Operations job even if they have Object Lock GOVERNANCE type in place.

Definition at line 67 of file S3SetObjectRetentionOperation.h.

◆ WithRetention() [1/2]

S3SetObjectRetentionOperation& Aws::S3Control::Model::S3SetObjectRetentionOperation::WithRetention ( const S3Retention value)
inline

Contains the Object Lock retention mode to be applied to all objects in the Batch Operations job. For more information, see Using S3 Object Lock retention with S3 Batch Operations in the Amazon Simple Storage Service Developer Guide.

Definition at line 113 of file S3SetObjectRetentionOperation.h.

◆ WithRetention() [2/2]

S3SetObjectRetentionOperation& Aws::S3Control::Model::S3SetObjectRetentionOperation::WithRetention ( S3Retention &&  value)
inline

Contains the Object Lock retention mode to be applied to all objects in the Batch Operations job. For more information, see Using S3 Object Lock retention with S3 Batch Operations in the Amazon Simple Storage Service Developer Guide.

Definition at line 122 of file S3SetObjectRetentionOperation.h.


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