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

#include <RestoreRequest.h>

Public Member Functions

 RestoreRequest ()
 
 RestoreRequest (const Aws::Utils::Xml::XmlNode &xmlNode)
 
RestoreRequestoperator= (const Aws::Utils::Xml::XmlNode &xmlNode)
 
void AddToNode (Aws::Utils::Xml::XmlNode &parentNode) const
 
int GetDays () const
 
bool DaysHasBeenSet () const
 
void SetDays (int value)
 
RestoreRequestWithDays (int value)
 
const GlacierJobParametersGetGlacierJobParameters () const
 
bool GlacierJobParametersHasBeenSet () const
 
void SetGlacierJobParameters (const GlacierJobParameters &value)
 
void SetGlacierJobParameters (GlacierJobParameters &&value)
 
RestoreRequestWithGlacierJobParameters (const GlacierJobParameters &value)
 
RestoreRequestWithGlacierJobParameters (GlacierJobParameters &&value)
 
const RestoreRequestTypeGetType () const
 
bool TypeHasBeenSet () const
 
void SetType (const RestoreRequestType &value)
 
void SetType (RestoreRequestType &&value)
 
RestoreRequestWithType (const RestoreRequestType &value)
 
RestoreRequestWithType (RestoreRequestType &&value)
 
const TierGetTier () const
 
bool TierHasBeenSet () const
 
void SetTier (const Tier &value)
 
void SetTier (Tier &&value)
 
RestoreRequestWithTier (const Tier &value)
 
RestoreRequestWithTier (Tier &&value)
 
const Aws::StringGetDescription () const
 
bool DescriptionHasBeenSet () const
 
void SetDescription (const Aws::String &value)
 
void SetDescription (Aws::String &&value)
 
void SetDescription (const char *value)
 
RestoreRequestWithDescription (const Aws::String &value)
 
RestoreRequestWithDescription (Aws::String &&value)
 
RestoreRequestWithDescription (const char *value)
 
const SelectParametersGetSelectParameters () const
 
bool SelectParametersHasBeenSet () const
 
void SetSelectParameters (const SelectParameters &value)
 
void SetSelectParameters (SelectParameters &&value)
 
RestoreRequestWithSelectParameters (const SelectParameters &value)
 
RestoreRequestWithSelectParameters (SelectParameters &&value)
 
const OutputLocationGetOutputLocation () const
 
bool OutputLocationHasBeenSet () const
 
void SetOutputLocation (const OutputLocation &value)
 
void SetOutputLocation (OutputLocation &&value)
 
RestoreRequestWithOutputLocation (const OutputLocation &value)
 
RestoreRequestWithOutputLocation (OutputLocation &&value)
 

Detailed Description

Container for restore job parameters.

See Also:

AWS API Reference

Definition at line 35 of file RestoreRequest.h.

Constructor & Destructor Documentation

◆ RestoreRequest() [1/2]

Aws::S3::Model::RestoreRequest::RestoreRequest ( )

◆ RestoreRequest() [2/2]

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

Member Function Documentation

◆ AddToNode()

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

◆ DaysHasBeenSet()

bool Aws::S3::Model::RestoreRequest::DaysHasBeenSet ( ) const
inline

Lifetime of the active copy in days. Do not use with restores that specify OutputLocation.

The Days element is required for regular restores, and must not be provided for select requests.

Definition at line 57 of file RestoreRequest.h.

◆ DescriptionHasBeenSet()

bool Aws::S3::Model::RestoreRequest::DescriptionHasBeenSet ( ) const
inline

The optional description for the job.

Definition at line 181 of file RestoreRequest.h.

◆ GetDays()

int Aws::S3::Model::RestoreRequest::GetDays ( ) const
inline

Lifetime of the active copy in days. Do not use with restores that specify OutputLocation.

The Days element is required for regular restores, and must not be provided for select requests.

Definition at line 50 of file RestoreRequest.h.

◆ GetDescription()

const Aws::String& Aws::S3::Model::RestoreRequest::GetDescription ( ) const
inline

The optional description for the job.

Definition at line 176 of file RestoreRequest.h.

◆ GetGlacierJobParameters()

const GlacierJobParameters& Aws::S3::Model::RestoreRequest::GetGlacierJobParameters ( ) const
inline

S3 Glacier related parameters pertaining to this job. Do not use with restores that specify OutputLocation.

Definition at line 78 of file RestoreRequest.h.

◆ GetOutputLocation()

const OutputLocation& Aws::S3::Model::RestoreRequest::GetOutputLocation ( ) const
inline

Describes the location where the restore job's output is stored.

Definition at line 248 of file RestoreRequest.h.

◆ GetSelectParameters()

const SelectParameters& Aws::S3::Model::RestoreRequest::GetSelectParameters ( ) const
inline

Describes the parameters for Select job types.

Definition at line 217 of file RestoreRequest.h.

◆ GetTier()

const Tier& Aws::S3::Model::RestoreRequest::GetTier ( ) const
inline

Retrieval tier at which the restore will be processed.

Definition at line 145 of file RestoreRequest.h.

◆ GetType()

const RestoreRequestType& Aws::S3::Model::RestoreRequest::GetType ( ) const
inline

Type of restore request.

Definition at line 114 of file RestoreRequest.h.

◆ GlacierJobParametersHasBeenSet()

bool Aws::S3::Model::RestoreRequest::GlacierJobParametersHasBeenSet ( ) const
inline

S3 Glacier related parameters pertaining to this job. Do not use with restores that specify OutputLocation.

Definition at line 84 of file RestoreRequest.h.

◆ operator=()

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

◆ OutputLocationHasBeenSet()

bool Aws::S3::Model::RestoreRequest::OutputLocationHasBeenSet ( ) const
inline

Describes the location where the restore job's output is stored.

Definition at line 253 of file RestoreRequest.h.

◆ SelectParametersHasBeenSet()

bool Aws::S3::Model::RestoreRequest::SelectParametersHasBeenSet ( ) const
inline

Describes the parameters for Select job types.

Definition at line 222 of file RestoreRequest.h.

◆ SetDays()

void Aws::S3::Model::RestoreRequest::SetDays ( int  value)
inline

Lifetime of the active copy in days. Do not use with restores that specify OutputLocation.

The Days element is required for regular restores, and must not be provided for select requests.

Definition at line 64 of file RestoreRequest.h.

◆ SetDescription() [1/3]

void Aws::S3::Model::RestoreRequest::SetDescription ( Aws::String &&  value)
inline

The optional description for the job.

Definition at line 191 of file RestoreRequest.h.

◆ SetDescription() [2/3]

void Aws::S3::Model::RestoreRequest::SetDescription ( const Aws::String value)
inline

The optional description for the job.

Definition at line 186 of file RestoreRequest.h.

◆ SetDescription() [3/3]

void Aws::S3::Model::RestoreRequest::SetDescription ( const char *  value)
inline

The optional description for the job.

Definition at line 196 of file RestoreRequest.h.

◆ SetGlacierJobParameters() [1/2]

void Aws::S3::Model::RestoreRequest::SetGlacierJobParameters ( const GlacierJobParameters value)
inline

S3 Glacier related parameters pertaining to this job. Do not use with restores that specify OutputLocation.

Definition at line 90 of file RestoreRequest.h.

◆ SetGlacierJobParameters() [2/2]

void Aws::S3::Model::RestoreRequest::SetGlacierJobParameters ( GlacierJobParameters &&  value)
inline

S3 Glacier related parameters pertaining to this job. Do not use with restores that specify OutputLocation.

Definition at line 96 of file RestoreRequest.h.

◆ SetOutputLocation() [1/2]

void Aws::S3::Model::RestoreRequest::SetOutputLocation ( const OutputLocation value)
inline

Describes the location where the restore job's output is stored.

Definition at line 258 of file RestoreRequest.h.

◆ SetOutputLocation() [2/2]

void Aws::S3::Model::RestoreRequest::SetOutputLocation ( OutputLocation &&  value)
inline

Describes the location where the restore job's output is stored.

Definition at line 263 of file RestoreRequest.h.

◆ SetSelectParameters() [1/2]

void Aws::S3::Model::RestoreRequest::SetSelectParameters ( const SelectParameters value)
inline

Describes the parameters for Select job types.

Definition at line 227 of file RestoreRequest.h.

◆ SetSelectParameters() [2/2]

void Aws::S3::Model::RestoreRequest::SetSelectParameters ( SelectParameters &&  value)
inline

Describes the parameters for Select job types.

Definition at line 232 of file RestoreRequest.h.

◆ SetTier() [1/2]

void Aws::S3::Model::RestoreRequest::SetTier ( const Tier value)
inline

Retrieval tier at which the restore will be processed.

Definition at line 155 of file RestoreRequest.h.

◆ SetTier() [2/2]

void Aws::S3::Model::RestoreRequest::SetTier ( Tier &&  value)
inline

Retrieval tier at which the restore will be processed.

Definition at line 160 of file RestoreRequest.h.

◆ SetType() [1/2]

void Aws::S3::Model::RestoreRequest::SetType ( const RestoreRequestType value)
inline

Type of restore request.

Definition at line 124 of file RestoreRequest.h.

◆ SetType() [2/2]

void Aws::S3::Model::RestoreRequest::SetType ( RestoreRequestType &&  value)
inline

Type of restore request.

Definition at line 129 of file RestoreRequest.h.

◆ TierHasBeenSet()

bool Aws::S3::Model::RestoreRequest::TierHasBeenSet ( ) const
inline

Retrieval tier at which the restore will be processed.

Definition at line 150 of file RestoreRequest.h.

◆ TypeHasBeenSet()

bool Aws::S3::Model::RestoreRequest::TypeHasBeenSet ( ) const
inline

Type of restore request.

Definition at line 119 of file RestoreRequest.h.

◆ WithDays()

RestoreRequest& Aws::S3::Model::RestoreRequest::WithDays ( int  value)
inline

Lifetime of the active copy in days. Do not use with restores that specify OutputLocation.

The Days element is required for regular restores, and must not be provided for select requests.

Definition at line 71 of file RestoreRequest.h.

◆ WithDescription() [1/3]

RestoreRequest& Aws::S3::Model::RestoreRequest::WithDescription ( Aws::String &&  value)
inline

The optional description for the job.

Definition at line 206 of file RestoreRequest.h.

◆ WithDescription() [2/3]

RestoreRequest& Aws::S3::Model::RestoreRequest::WithDescription ( const Aws::String value)
inline

The optional description for the job.

Definition at line 201 of file RestoreRequest.h.

◆ WithDescription() [3/3]

RestoreRequest& Aws::S3::Model::RestoreRequest::WithDescription ( const char *  value)
inline

The optional description for the job.

Definition at line 211 of file RestoreRequest.h.

◆ WithGlacierJobParameters() [1/2]

RestoreRequest& Aws::S3::Model::RestoreRequest::WithGlacierJobParameters ( const GlacierJobParameters value)
inline

S3 Glacier related parameters pertaining to this job. Do not use with restores that specify OutputLocation.

Definition at line 102 of file RestoreRequest.h.

◆ WithGlacierJobParameters() [2/2]

RestoreRequest& Aws::S3::Model::RestoreRequest::WithGlacierJobParameters ( GlacierJobParameters &&  value)
inline

S3 Glacier related parameters pertaining to this job. Do not use with restores that specify OutputLocation.

Definition at line 108 of file RestoreRequest.h.

◆ WithOutputLocation() [1/2]

RestoreRequest& Aws::S3::Model::RestoreRequest::WithOutputLocation ( const OutputLocation value)
inline

Describes the location where the restore job's output is stored.

Definition at line 268 of file RestoreRequest.h.

◆ WithOutputLocation() [2/2]

RestoreRequest& Aws::S3::Model::RestoreRequest::WithOutputLocation ( OutputLocation &&  value)
inline

Describes the location where the restore job's output is stored.

Definition at line 273 of file RestoreRequest.h.

◆ WithSelectParameters() [1/2]

RestoreRequest& Aws::S3::Model::RestoreRequest::WithSelectParameters ( const SelectParameters value)
inline

Describes the parameters for Select job types.

Definition at line 237 of file RestoreRequest.h.

◆ WithSelectParameters() [2/2]

RestoreRequest& Aws::S3::Model::RestoreRequest::WithSelectParameters ( SelectParameters &&  value)
inline

Describes the parameters for Select job types.

Definition at line 242 of file RestoreRequest.h.

◆ WithTier() [1/2]

RestoreRequest& Aws::S3::Model::RestoreRequest::WithTier ( const Tier value)
inline

Retrieval tier at which the restore will be processed.

Definition at line 165 of file RestoreRequest.h.

◆ WithTier() [2/2]

RestoreRequest& Aws::S3::Model::RestoreRequest::WithTier ( Tier &&  value)
inline

Retrieval tier at which the restore will be processed.

Definition at line 170 of file RestoreRequest.h.

◆ WithType() [1/2]

RestoreRequest& Aws::S3::Model::RestoreRequest::WithType ( const RestoreRequestType value)
inline

Type of restore request.

Definition at line 134 of file RestoreRequest.h.

◆ WithType() [2/2]

RestoreRequest& Aws::S3::Model::RestoreRequest::WithType ( RestoreRequestType &&  value)
inline

Type of restore request.

Definition at line 139 of file RestoreRequest.h.


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