Aws::Glacier::Model::JobParameters Class Reference

#include <JobParameters.h>

Public Member Functions
	JobParameters ()
	JobParameters (Aws::Utils::Json::JsonView jsonValue)
JobParameters &	operator= (Aws::Utils::Json::JsonView jsonValue)
Aws::Utils::Json::JsonValue	Jsonize () const
const Aws::String &	GetFormat () const
bool	FormatHasBeenSet () const
void	SetFormat (const Aws::String &value)
void	SetFormat (Aws::String &&value)
void	SetFormat (const char *value)
JobParameters &	WithFormat (const Aws::String &value)
JobParameters &	WithFormat (Aws::String &&value)
JobParameters &	WithFormat (const char *value)
const Aws::String &	GetType () const
bool	TypeHasBeenSet () const
void	SetType (const Aws::String &value)
void	SetType (Aws::String &&value)
void	SetType (const char *value)
JobParameters &	WithType (const Aws::String &value)
JobParameters &	WithType (Aws::String &&value)
JobParameters &	WithType (const char *value)
const Aws::String &	GetArchiveId () const
bool	ArchiveIdHasBeenSet () const
void	SetArchiveId (const Aws::String &value)
void	SetArchiveId (Aws::String &&value)
void	SetArchiveId (const char *value)
JobParameters &	WithArchiveId (const Aws::String &value)
JobParameters &	WithArchiveId (Aws::String &&value)
JobParameters &	WithArchiveId (const char *value)
const Aws::String &	GetDescription () const
bool	DescriptionHasBeenSet () const
void	SetDescription (const Aws::String &value)
void	SetDescription (Aws::String &&value)
void	SetDescription (const char *value)
JobParameters &	WithDescription (const Aws::String &value)
JobParameters &	WithDescription (Aws::String &&value)
JobParameters &	WithDescription (const char *value)
const Aws::String &	GetSNSTopic () const
bool	SNSTopicHasBeenSet () const
void	SetSNSTopic (const Aws::String &value)
void	SetSNSTopic (Aws::String &&value)
void	SetSNSTopic (const char *value)
JobParameters &	WithSNSTopic (const Aws::String &value)
JobParameters &	WithSNSTopic (Aws::String &&value)
JobParameters &	WithSNSTopic (const char *value)
const Aws::String &	GetRetrievalByteRange () const
bool	RetrievalByteRangeHasBeenSet () const
void	SetRetrievalByteRange (const Aws::String &value)
void	SetRetrievalByteRange (Aws::String &&value)
void	SetRetrievalByteRange (const char *value)
JobParameters &	WithRetrievalByteRange (const Aws::String &value)
JobParameters &	WithRetrievalByteRange (Aws::String &&value)
JobParameters &	WithRetrievalByteRange (const char *value)
const Aws::String &	GetTier () const
bool	TierHasBeenSet () const
void	SetTier (const Aws::String &value)
void	SetTier (Aws::String &&value)
void	SetTier (const char *value)
JobParameters &	WithTier (const Aws::String &value)
JobParameters &	WithTier (Aws::String &&value)
JobParameters &	WithTier (const char *value)
const InventoryRetrievalJobInput &	GetInventoryRetrievalParameters () const
bool	InventoryRetrievalParametersHasBeenSet () const
void	SetInventoryRetrievalParameters (const InventoryRetrievalJobInput &value)
void	SetInventoryRetrievalParameters (InventoryRetrievalJobInput &&value)
JobParameters &	WithInventoryRetrievalParameters (const InventoryRetrievalJobInput &value)
JobParameters &	WithInventoryRetrievalParameters (InventoryRetrievalJobInput &&value)
const SelectParameters &	GetSelectParameters () const
bool	SelectParametersHasBeenSet () const
void	SetSelectParameters (const SelectParameters &value)
void	SetSelectParameters (SelectParameters &&value)
JobParameters &	WithSelectParameters (const SelectParameters &value)
JobParameters &	WithSelectParameters (SelectParameters &&value)
const OutputLocation &	GetOutputLocation () const
bool	OutputLocationHasBeenSet () const
void	SetOutputLocation (const OutputLocation &value)
void	SetOutputLocation (OutputLocation &&value)
JobParameters &	WithOutputLocation (const OutputLocation &value)
JobParameters &	WithOutputLocation (OutputLocation &&value)

Detailed Description

Provides options for defining a job.

See Also:

AWS API Reference

Definition at line 34 of file JobParameters.h.

Constructor & Destructor Documentation

JobParameters() [1/2]

Aws::Glacier::Model::JobParameters::JobParameters

(

)

JobParameters() [2/2]

Aws::Glacier::Model::JobParameters::JobParameters

(

Aws::Utils::Json::JsonView

jsonValue

)

Member Function Documentation

ArchiveIdHasBeenSet()

bool Aws::Glacier::Model::JobParameters::ArchiveIdHasBeenSet ( ) const

inline

The ID of the archive that you want to retrieve. This field is required only if Type is set to select or archive-retrievalcode>. An error occurs if you specify this request parameter for an inventory retrieval job request.

Definition at line 179 of file JobParameters.h.

DescriptionHasBeenSet()

bool Aws::Glacier::Model::JobParameters::DescriptionHasBeenSet ( ) const

inline

The optional description for the job. The description must be less than or equal to 1,024 bytes. The allowable characters are 7-bit ASCII without control codes-specifically, ASCII values 32-126 decimal or 0x20-0x7E hexadecimal.

Definition at line 242 of file JobParameters.h.

FormatHasBeenSet()

bool Aws::Glacier::Model::JobParameters::FormatHasBeenSet ( ) const

inline

When initiating a job to retrieve a vault inventory, you can optionally add this parameter to your request to specify the output format. If you are initiating an inventory job and do not specify a Format field, JSON is the default format. Valid values are "CSV" and "JSON".

Definition at line 57 of file JobParameters.h.

GetArchiveId()

const Aws::String& Aws::Glacier::Model::JobParameters::GetArchiveId ( ) const

inline

The ID of the archive that you want to retrieve. This field is required only if Type is set to select or archive-retrievalcode>. An error occurs if you specify this request parameter for an inventory retrieval job request.

Definition at line 171 of file JobParameters.h.

GetDescription()

const Aws::String& Aws::Glacier::Model::JobParameters::GetDescription ( ) const

inline

The optional description for the job. The description must be less than or equal to 1,024 bytes. The allowable characters are 7-bit ASCII without control codes-specifically, ASCII values 32-126 decimal or 0x20-0x7E hexadecimal.

Definition at line 235 of file JobParameters.h.

GetFormat()

const Aws::String& Aws::Glacier::Model::JobParameters::GetFormat ( ) const

inline

When initiating a job to retrieve a vault inventory, you can optionally add this parameter to your request to specify the output format. If you are initiating an inventory job and do not specify a Format field, JSON is the default format. Valid values are "CSV" and "JSON".

Definition at line 49 of file JobParameters.h.

GetInventoryRetrievalParameters()

const InventoryRetrievalJobInput& Aws::Glacier::Model::JobParameters::GetInventoryRetrievalParameters ( ) const

inline

Input parameters used for range inventory retrieval.

Definition at line 509 of file JobParameters.h.

GetOutputLocation()

const OutputLocation& Aws::Glacier::Model::JobParameters::GetOutputLocation ( ) const

inline

Contains information about the location where the select job results are stored.

Definition at line 572 of file JobParameters.h.

GetRetrievalByteRange()

const Aws::String& Aws::Glacier::Model::JobParameters::GetRetrievalByteRange ( ) const

inline

The byte range to retrieve for an archive retrieval. in the form "<i>StartByteValue</i>-<i>EndByteValue</i>" If not specified, the whole archive is retrieved. If specified, the byte range must be megabyte (1024*1024) aligned which means that StartByteValue must be divisible by 1 MB and EndByteValue plus 1 must be divisible by 1 MB or be the end of the archive specified as the archive byte size value minus 1. If RetrievalByteRange is not megabyte aligned, this operation returns a 400 response.

An error occurs if you specify this field for an inventory retrieval job request.

Definition at line 362 of file JobParameters.h.

GetSelectParameters()

const SelectParameters& Aws::Glacier::Model::JobParameters::GetSelectParameters ( ) const

inline

Contains the parameters that define a job.

Definition at line 540 of file JobParameters.h.

GetSNSTopic()

const Aws::String& Aws::Glacier::Model::JobParameters::GetSNSTopic ( ) const

inline

The Amazon SNS topic ARN to which Amazon S3 Glacier sends a notification when the job is completed and the output is ready for you to download. The specified topic publishes the notification to its subscribers. The SNS topic must exist.

Definition at line 293 of file JobParameters.h.

GetTier()

const Aws::String& Aws::Glacier::Model::JobParameters::GetTier ( ) const

inline

The tier to use for a select or an archive retrieval job. Valid values are Expedited, Standard, or Bulk. Standard is the default.

Definition at line 454 of file JobParameters.h.

GetType()

const Aws::String& Aws::Glacier::Model::JobParameters::GetType ( ) const

inline

The job type. You can initiate a job to perform a select query on an archive, retrieve an archive, or get an inventory of a vault. Valid values are "select", "archive-retrieval" and "inventory-retrieval".

Definition at line 113 of file JobParameters.h.

InventoryRetrievalParametersHasBeenSet()

bool Aws::Glacier::Model::JobParameters::InventoryRetrievalParametersHasBeenSet ( ) const

inline

Input parameters used for range inventory retrieval.

Definition at line 514 of file JobParameters.h.

Jsonize()

Aws::Utils::Json::JsonValue Aws::Glacier::Model::JobParameters::Jsonize

(

)

const

operator=()

JobParameters& Aws::Glacier::Model::JobParameters::operator=

(

Aws::Utils::Json::JsonView

jsonValue

)

OutputLocationHasBeenSet()

bool Aws::Glacier::Model::JobParameters::OutputLocationHasBeenSet ( ) const

inline

Contains information about the location where the select job results are stored.

Definition at line 578 of file JobParameters.h.

RetrievalByteRangeHasBeenSet()

bool Aws::Glacier::Model::JobParameters::RetrievalByteRangeHasBeenSet ( ) const

inline

The byte range to retrieve for an archive retrieval. in the form "<i>StartByteValue</i>-<i>EndByteValue</i>" If not specified, the whole archive is retrieved. If specified, the byte range must be megabyte (1024*1024) aligned which means that StartByteValue must be divisible by 1 MB and EndByteValue plus 1 must be divisible by 1 MB or be the end of the archive specified as the archive byte size value minus 1. If RetrievalByteRange is not megabyte aligned, this operation returns a 400 response.

An error occurs if you specify this field for an inventory retrieval job request.

Definition at line 374 of file JobParameters.h.

SelectParametersHasBeenSet()

bool Aws::Glacier::Model::JobParameters::SelectParametersHasBeenSet ( ) const

inline

Contains the parameters that define a job.

Definition at line 545 of file JobParameters.h.

SetArchiveId() [1/3]

void Aws::Glacier::Model::JobParameters::SetArchiveId ( const Aws::String &  value )

inline

The ID of the archive that you want to retrieve. This field is required only if Type is set to select or archive-retrievalcode>. An error occurs if you specify this request parameter for an inventory retrieval job request.

Definition at line 187 of file JobParameters.h.

SetArchiveId() [2/3]

void Aws::Glacier::Model::JobParameters::SetArchiveId ( Aws::String &&  value )

inline

The ID of the archive that you want to retrieve. This field is required only if Type is set to select or archive-retrievalcode>. An error occurs if you specify this request parameter for an inventory retrieval job request.

Definition at line 195 of file JobParameters.h.

SetArchiveId() [3/3]

void Aws::Glacier::Model::JobParameters::SetArchiveId ( const char *  value )

inline

The ID of the archive that you want to retrieve. This field is required only if Type is set to select or archive-retrievalcode>. An error occurs if you specify this request parameter for an inventory retrieval job request.

Definition at line 203 of file JobParameters.h.

SetDescription() [1/3]

void Aws::Glacier::Model::JobParameters::SetDescription ( const Aws::String &  value )

inline

The optional description for the job. The description must be less than or equal to 1,024 bytes. The allowable characters are 7-bit ASCII without control codes-specifically, ASCII values 32-126 decimal or 0x20-0x7E hexadecimal.

Definition at line 249 of file JobParameters.h.

SetDescription() [2/3]

void Aws::Glacier::Model::JobParameters::SetDescription ( Aws::String &&  value )

inline

The optional description for the job. The description must be less than or equal to 1,024 bytes. The allowable characters are 7-bit ASCII without control codes-specifically, ASCII values 32-126 decimal or 0x20-0x7E hexadecimal.

Definition at line 256 of file JobParameters.h.

SetDescription() [3/3]

void Aws::Glacier::Model::JobParameters::SetDescription ( const char *  value )

inline

The optional description for the job. The description must be less than or equal to 1,024 bytes. The allowable characters are 7-bit ASCII without control codes-specifically, ASCII values 32-126 decimal or 0x20-0x7E hexadecimal.

Definition at line 263 of file JobParameters.h.

SetFormat() [1/3]

void Aws::Glacier::Model::JobParameters::SetFormat ( const Aws::String &  value )

inline

When initiating a job to retrieve a vault inventory, you can optionally add this parameter to your request to specify the output format. If you are initiating an inventory job and do not specify a Format field, JSON is the default format. Valid values are "CSV" and "JSON".

Definition at line 65 of file JobParameters.h.

SetFormat() [2/3]

void Aws::Glacier::Model::JobParameters::SetFormat ( Aws::String &&  value )

inline

When initiating a job to retrieve a vault inventory, you can optionally add this parameter to your request to specify the output format. If you are initiating an inventory job and do not specify a Format field, JSON is the default format. Valid values are "CSV" and "JSON".

Definition at line 73 of file JobParameters.h.

SetFormat() [3/3]

void Aws::Glacier::Model::JobParameters::SetFormat ( const char *  value )

inline

When initiating a job to retrieve a vault inventory, you can optionally add this parameter to your request to specify the output format. If you are initiating an inventory job and do not specify a Format field, JSON is the default format. Valid values are "CSV" and "JSON".

Definition at line 81 of file JobParameters.h.

SetInventoryRetrievalParameters() [1/2]

void Aws::Glacier::Model::JobParameters::SetInventoryRetrievalParameters ( const InventoryRetrievalJobInput &  value )

inline

Input parameters used for range inventory retrieval.

Definition at line 519 of file JobParameters.h.

SetInventoryRetrievalParameters() [2/2]

void Aws::Glacier::Model::JobParameters::SetInventoryRetrievalParameters ( InventoryRetrievalJobInput &&  value )

inline

Input parameters used for range inventory retrieval.

Definition at line 524 of file JobParameters.h.

SetOutputLocation() [1/2]

void Aws::Glacier::Model::JobParameters::SetOutputLocation ( const OutputLocation &  value )

inline

Contains information about the location where the select job results are stored.

Definition at line 584 of file JobParameters.h.

SetOutputLocation() [2/2]

void Aws::Glacier::Model::JobParameters::SetOutputLocation ( OutputLocation &&  value )

inline

Contains information about the location where the select job results are stored.

Definition at line 590 of file JobParameters.h.

SetRetrievalByteRange() [1/3]

void Aws::Glacier::Model::JobParameters::SetRetrievalByteRange ( const Aws::String &  value )

inline

The byte range to retrieve for an archive retrieval. in the form "<i>StartByteValue</i>-<i>EndByteValue</i>" If not specified, the whole archive is retrieved. If specified, the byte range must be megabyte (1024*1024) aligned which means that StartByteValue must be divisible by 1 MB and EndByteValue plus 1 must be divisible by 1 MB or be the end of the archive specified as the archive byte size value minus 1. If RetrievalByteRange is not megabyte aligned, this operation returns a 400 response.

An error occurs if you specify this field for an inventory retrieval job request.

Definition at line 386 of file JobParameters.h.

SetRetrievalByteRange() [2/3]

void Aws::Glacier::Model::JobParameters::SetRetrievalByteRange ( Aws::String &&  value )

inline

The byte range to retrieve for an archive retrieval. in the form "<i>StartByteValue</i>-<i>EndByteValue</i>" If not specified, the whole archive is retrieved. If specified, the byte range must be megabyte (1024*1024) aligned which means that StartByteValue must be divisible by 1 MB and EndByteValue plus 1 must be divisible by 1 MB or be the end of the archive specified as the archive byte size value minus 1. If RetrievalByteRange is not megabyte aligned, this operation returns a 400 response.

An error occurs if you specify this field for an inventory retrieval job request.

Definition at line 398 of file JobParameters.h.

SetRetrievalByteRange() [3/3]

void Aws::Glacier::Model::JobParameters::SetRetrievalByteRange ( const char *  value )

inline

The byte range to retrieve for an archive retrieval. in the form "<i>StartByteValue</i>-<i>EndByteValue</i>" If not specified, the whole archive is retrieved. If specified, the byte range must be megabyte (1024*1024) aligned which means that StartByteValue must be divisible by 1 MB and EndByteValue plus 1 must be divisible by 1 MB or be the end of the archive specified as the archive byte size value minus 1. If RetrievalByteRange is not megabyte aligned, this operation returns a 400 response.

An error occurs if you specify this field for an inventory retrieval job request.

Definition at line 410 of file JobParameters.h.

SetSelectParameters() [1/2]

void Aws::Glacier::Model::JobParameters::SetSelectParameters ( const SelectParameters &  value )

inline

Contains the parameters that define a job.

Definition at line 550 of file JobParameters.h.

SetSelectParameters() [2/2]

void Aws::Glacier::Model::JobParameters::SetSelectParameters ( SelectParameters &&  value )

inline

Contains the parameters that define a job.

Definition at line 555 of file JobParameters.h.

SetSNSTopic() [1/3]

void Aws::Glacier::Model::JobParameters::SetSNSTopic ( const Aws::String &  value )

inline

The Amazon SNS topic ARN to which Amazon S3 Glacier sends a notification when the job is completed and the output is ready for you to download. The specified topic publishes the notification to its subscribers. The SNS topic must exist.

Definition at line 309 of file JobParameters.h.

SetSNSTopic() [2/3]

void Aws::Glacier::Model::JobParameters::SetSNSTopic ( Aws::String &&  value )

inline

The Amazon SNS topic ARN to which Amazon S3 Glacier sends a notification when the job is completed and the output is ready for you to download. The specified topic publishes the notification to its subscribers. The SNS topic must exist.

Definition at line 317 of file JobParameters.h.

SetSNSTopic() [3/3]

void Aws::Glacier::Model::JobParameters::SetSNSTopic ( const char *  value )

inline

The Amazon SNS topic ARN to which Amazon S3 Glacier sends a notification when the job is completed and the output is ready for you to download. The specified topic publishes the notification to its subscribers. The SNS topic must exist.

Definition at line 325 of file JobParameters.h.

SetTier() [1/3]

void Aws::Glacier::Model::JobParameters::SetTier ( const Aws::String &  value )

inline

The tier to use for a select or an archive retrieval job. Valid values are Expedited, Standard, or Bulk. Standard is the default.

Definition at line 468 of file JobParameters.h.

SetTier() [2/3]

void Aws::Glacier::Model::JobParameters::SetTier ( Aws::String &&  value )

inline

The tier to use for a select or an archive retrieval job. Valid values are Expedited, Standard, or Bulk. Standard is the default.

Definition at line 475 of file JobParameters.h.

SetTier() [3/3]

void Aws::Glacier::Model::JobParameters::SetTier ( const char *  value )

inline

The tier to use for a select or an archive retrieval job. Valid values are Expedited, Standard, or Bulk. Standard is the default.

Definition at line 482 of file JobParameters.h.

SetType() [1/3]

void Aws::Glacier::Model::JobParameters::SetType ( const Aws::String &  value )

inline

The job type. You can initiate a job to perform a select query on an archive, retrieve an archive, or get an inventory of a vault. Valid values are "select", "archive-retrieval" and "inventory-retrieval".

Definition at line 127 of file JobParameters.h.

SetType() [2/3]

void Aws::Glacier::Model::JobParameters::SetType ( Aws::String &&  value )

inline

The job type. You can initiate a job to perform a select query on an archive, retrieve an archive, or get an inventory of a vault. Valid values are "select", "archive-retrieval" and "inventory-retrieval".

Definition at line 134 of file JobParameters.h.

SetType() [3/3]

void Aws::Glacier::Model::JobParameters::SetType ( const char *  value )

inline

The job type. You can initiate a job to perform a select query on an archive, retrieve an archive, or get an inventory of a vault. Valid values are "select", "archive-retrieval" and "inventory-retrieval".

Definition at line 141 of file JobParameters.h.

SNSTopicHasBeenSet()

bool Aws::Glacier::Model::JobParameters::SNSTopicHasBeenSet ( ) const

inline

The Amazon SNS topic ARN to which Amazon S3 Glacier sends a notification when the job is completed and the output is ready for you to download. The specified topic publishes the notification to its subscribers. The SNS topic must exist.

Definition at line 301 of file JobParameters.h.

TierHasBeenSet()

bool Aws::Glacier::Model::JobParameters::TierHasBeenSet ( ) const

inline

The tier to use for a select or an archive retrieval job. Valid values are Expedited, Standard, or Bulk. Standard is the default.

Definition at line 461 of file JobParameters.h.

TypeHasBeenSet()

bool Aws::Glacier::Model::JobParameters::TypeHasBeenSet ( ) const

inline

The job type. You can initiate a job to perform a select query on an archive, retrieve an archive, or get an inventory of a vault. Valid values are "select", "archive-retrieval" and "inventory-retrieval".

Definition at line 120 of file JobParameters.h.

WithArchiveId() [1/3]

JobParameters& Aws::Glacier::Model::JobParameters::WithArchiveId ( const Aws::String &  value )

inline

The ID of the archive that you want to retrieve. This field is required only if Type is set to select or archive-retrievalcode>. An error occurs if you specify this request parameter for an inventory retrieval job request.

Definition at line 211 of file JobParameters.h.

WithArchiveId() [2/3]

JobParameters& Aws::Glacier::Model::JobParameters::WithArchiveId ( Aws::String &&  value )

inline

The ID of the archive that you want to retrieve. This field is required only if Type is set to select or archive-retrievalcode>. An error occurs if you specify this request parameter for an inventory retrieval job request.

Definition at line 219 of file JobParameters.h.

WithArchiveId() [3/3]

JobParameters& Aws::Glacier::Model::JobParameters::WithArchiveId ( const char *  value )

inline

The ID of the archive that you want to retrieve. This field is required only if Type is set to select or archive-retrievalcode>. An error occurs if you specify this request parameter for an inventory retrieval job request.

Definition at line 227 of file JobParameters.h.

WithDescription() [1/3]

JobParameters& Aws::Glacier::Model::JobParameters::WithDescription ( const Aws::String &  value )

inline

The optional description for the job. The description must be less than or equal to 1,024 bytes. The allowable characters are 7-bit ASCII without control codes-specifically, ASCII values 32-126 decimal or 0x20-0x7E hexadecimal.

Definition at line 270 of file JobParameters.h.

WithDescription() [2/3]

JobParameters& Aws::Glacier::Model::JobParameters::WithDescription ( Aws::String &&  value )

inline

The optional description for the job. The description must be less than or equal to 1,024 bytes. The allowable characters are 7-bit ASCII without control codes-specifically, ASCII values 32-126 decimal or 0x20-0x7E hexadecimal.

Definition at line 277 of file JobParameters.h.

WithDescription() [3/3]

JobParameters& Aws::Glacier::Model::JobParameters::WithDescription ( const char *  value )

inline

The optional description for the job. The description must be less than or equal to 1,024 bytes. The allowable characters are 7-bit ASCII without control codes-specifically, ASCII values 32-126 decimal or 0x20-0x7E hexadecimal.

Definition at line 284 of file JobParameters.h.

WithFormat() [1/3]

JobParameters& Aws::Glacier::Model::JobParameters::WithFormat ( const Aws::String &  value )

inline

When initiating a job to retrieve a vault inventory, you can optionally add this parameter to your request to specify the output format. If you are initiating an inventory job and do not specify a Format field, JSON is the default format. Valid values are "CSV" and "JSON".

Definition at line 89 of file JobParameters.h.

WithFormat() [2/3]

JobParameters& Aws::Glacier::Model::JobParameters::WithFormat ( Aws::String &&  value )

inline

When initiating a job to retrieve a vault inventory, you can optionally add this parameter to your request to specify the output format. If you are initiating an inventory job and do not specify a Format field, JSON is the default format. Valid values are "CSV" and "JSON".

Definition at line 97 of file JobParameters.h.

WithFormat() [3/3]

JobParameters& Aws::Glacier::Model::JobParameters::WithFormat ( const char *  value )

inline

When initiating a job to retrieve a vault inventory, you can optionally add this parameter to your request to specify the output format. If you are initiating an inventory job and do not specify a Format field, JSON is the default format. Valid values are "CSV" and "JSON".

Definition at line 105 of file JobParameters.h.

WithInventoryRetrievalParameters() [1/2]

JobParameters& Aws::Glacier::Model::JobParameters::WithInventoryRetrievalParameters ( const InventoryRetrievalJobInput &  value )

inline

Input parameters used for range inventory retrieval.

Definition at line 529 of file JobParameters.h.

WithInventoryRetrievalParameters() [2/2]

JobParameters& Aws::Glacier::Model::JobParameters::WithInventoryRetrievalParameters ( InventoryRetrievalJobInput &&  value )

inline

Input parameters used for range inventory retrieval.

Definition at line 534 of file JobParameters.h.

WithOutputLocation() [1/2]

JobParameters& Aws::Glacier::Model::JobParameters::WithOutputLocation ( const OutputLocation &  value )

inline

Contains information about the location where the select job results are stored.

Definition at line 596 of file JobParameters.h.

WithOutputLocation() [2/2]

JobParameters& Aws::Glacier::Model::JobParameters::WithOutputLocation ( OutputLocation &&  value )

inline

Contains information about the location where the select job results are stored.

Definition at line 602 of file JobParameters.h.

WithRetrievalByteRange() [1/3]

JobParameters& Aws::Glacier::Model::JobParameters::WithRetrievalByteRange ( const Aws::String &  value )

inline

The byte range to retrieve for an archive retrieval. in the form "<i>StartByteValue</i>-<i>EndByteValue</i>" If not specified, the whole archive is retrieved. If specified, the byte range must be megabyte (1024*1024) aligned which means that StartByteValue must be divisible by 1 MB and EndByteValue plus 1 must be divisible by 1 MB or be the end of the archive specified as the archive byte size value minus 1. If RetrievalByteRange is not megabyte aligned, this operation returns a 400 response.

An error occurs if you specify this field for an inventory retrieval job request.

Definition at line 422 of file JobParameters.h.

WithRetrievalByteRange() [2/3]

JobParameters& Aws::Glacier::Model::JobParameters::WithRetrievalByteRange ( Aws::String &&  value )

inline

The byte range to retrieve for an archive retrieval. in the form "<i>StartByteValue</i>-<i>EndByteValue</i>" If not specified, the whole archive is retrieved. If specified, the byte range must be megabyte (1024*1024) aligned which means that StartByteValue must be divisible by 1 MB and EndByteValue plus 1 must be divisible by 1 MB or be the end of the archive specified as the archive byte size value minus 1. If RetrievalByteRange is not megabyte aligned, this operation returns a 400 response.

An error occurs if you specify this field for an inventory retrieval job request.

Definition at line 434 of file JobParameters.h.

WithRetrievalByteRange() [3/3]

JobParameters& Aws::Glacier::Model::JobParameters::WithRetrievalByteRange ( const char *  value )

inline

The byte range to retrieve for an archive retrieval. in the form "<i>StartByteValue</i>-<i>EndByteValue</i>" If not specified, the whole archive is retrieved. If specified, the byte range must be megabyte (1024*1024) aligned which means that StartByteValue must be divisible by 1 MB and EndByteValue plus 1 must be divisible by 1 MB or be the end of the archive specified as the archive byte size value minus 1. If RetrievalByteRange is not megabyte aligned, this operation returns a 400 response.

An error occurs if you specify this field for an inventory retrieval job request.

Definition at line 446 of file JobParameters.h.

WithSelectParameters() [1/2]

JobParameters& Aws::Glacier::Model::JobParameters::WithSelectParameters ( const SelectParameters &  value )

inline

Contains the parameters that define a job.

Definition at line 560 of file JobParameters.h.

WithSelectParameters() [2/2]

JobParameters& Aws::Glacier::Model::JobParameters::WithSelectParameters ( SelectParameters &&  value )

inline

Contains the parameters that define a job.

Definition at line 565 of file JobParameters.h.

WithSNSTopic() [1/3]

JobParameters& Aws::Glacier::Model::JobParameters::WithSNSTopic ( const Aws::String &  value )

inline

The Amazon SNS topic ARN to which Amazon S3 Glacier sends a notification when the job is completed and the output is ready for you to download. The specified topic publishes the notification to its subscribers. The SNS topic must exist.

Definition at line 333 of file JobParameters.h.

WithSNSTopic() [2/3]

JobParameters& Aws::Glacier::Model::JobParameters::WithSNSTopic ( Aws::String &&  value )

inline

The Amazon SNS topic ARN to which Amazon S3 Glacier sends a notification when the job is completed and the output is ready for you to download. The specified topic publishes the notification to its subscribers. The SNS topic must exist.

Definition at line 341 of file JobParameters.h.

WithSNSTopic() [3/3]

JobParameters& Aws::Glacier::Model::JobParameters::WithSNSTopic ( const char *  value )

inline

The Amazon SNS topic ARN to which Amazon S3 Glacier sends a notification when the job is completed and the output is ready for you to download. The specified topic publishes the notification to its subscribers. The SNS topic must exist.

Definition at line 349 of file JobParameters.h.

WithTier() [1/3]

JobParameters& Aws::Glacier::Model::JobParameters::WithTier ( const Aws::String &  value )

inline

The tier to use for a select or an archive retrieval job. Valid values are Expedited, Standard, or Bulk. Standard is the default.

Definition at line 489 of file JobParameters.h.

WithTier() [2/3]

JobParameters& Aws::Glacier::Model::JobParameters::WithTier ( Aws::String &&  value )

inline

The tier to use for a select or an archive retrieval job. Valid values are Expedited, Standard, or Bulk. Standard is the default.

Definition at line 496 of file JobParameters.h.

WithTier() [3/3]

JobParameters& Aws::Glacier::Model::JobParameters::WithTier ( const char *  value )

inline

The tier to use for a select or an archive retrieval job. Valid values are Expedited, Standard, or Bulk. Standard is the default.

Definition at line 503 of file JobParameters.h.

WithType() [1/3]

JobParameters& Aws::Glacier::Model::JobParameters::WithType ( const Aws::String &  value )

inline

The job type. You can initiate a job to perform a select query on an archive, retrieve an archive, or get an inventory of a vault. Valid values are "select", "archive-retrieval" and "inventory-retrieval".

Definition at line 148 of file JobParameters.h.

WithType() [2/3]

JobParameters& Aws::Glacier::Model::JobParameters::WithType ( Aws::String &&  value )

inline

The job type. You can initiate a job to perform a select query on an archive, retrieve an archive, or get an inventory of a vault. Valid values are "select", "archive-retrieval" and "inventory-retrieval".

Definition at line 155 of file JobParameters.h.

WithType() [3/3]

JobParameters& Aws::Glacier::Model::JobParameters::WithType ( const char *  value )

inline

The job type. You can initiate a job to perform a select query on an archive, retrieve an archive, or get an inventory of a vault. Valid values are "select", "archive-retrieval" and "inventory-retrieval".

Definition at line 162 of file JobParameters.h.

---

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

• aws-cpp-sdk-glacier/include/aws/glacier/model/JobParameters.h