#include <InventoryRetrievalJobDescription.h>

Public Member Functions
	InventoryRetrievalJobDescription ()

	InventoryRetrievalJobDescription (Aws::Utils::Json::JsonView jsonValue)

InventoryRetrievalJobDescription &	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)

InventoryRetrievalJobDescription &	WithFormat (const Aws::String &value)

InventoryRetrievalJobDescription &	WithFormat (Aws::String &&value)

InventoryRetrievalJobDescription &	WithFormat (const char *value)

const Aws::String &	GetStartDate () const

bool	StartDateHasBeenSet () const

void	SetStartDate (const Aws::String &value)

void	SetStartDate (Aws::String &&value)

void	SetStartDate (const char *value)

InventoryRetrievalJobDescription &	WithStartDate (const Aws::String &value)

InventoryRetrievalJobDescription &	WithStartDate (Aws::String &&value)

InventoryRetrievalJobDescription &	WithStartDate (const char *value)

const Aws::String &	GetEndDate () const

bool	EndDateHasBeenSet () const

void	SetEndDate (const Aws::String &value)

void	SetEndDate (Aws::String &&value)

void	SetEndDate (const char *value)

InventoryRetrievalJobDescription &	WithEndDate (const Aws::String &value)

InventoryRetrievalJobDescription &	WithEndDate (Aws::String &&value)

InventoryRetrievalJobDescription &	WithEndDate (const char *value)

const Aws::String &	GetLimit () const

bool	LimitHasBeenSet () const

void	SetLimit (const Aws::String &value)

void	SetLimit (Aws::String &&value)

void	SetLimit (const char *value)

InventoryRetrievalJobDescription &	WithLimit (const Aws::String &value)

InventoryRetrievalJobDescription &	WithLimit (Aws::String &&value)

InventoryRetrievalJobDescription &	WithLimit (const char *value)

const Aws::String &	GetMarker () const

bool	MarkerHasBeenSet () const

void	SetMarker (const Aws::String &value)

void	SetMarker (Aws::String &&value)

void	SetMarker (const char *value)

InventoryRetrievalJobDescription &	WithMarker (const Aws::String &value)

InventoryRetrievalJobDescription &	WithMarker (Aws::String &&value)

InventoryRetrievalJobDescription &	WithMarker (const char *value)

Detailed Description

Describes the options for a range inventory retrieval job.

Constructor & Destructor Documentation

◆ InventoryRetrievalJobDescription() [1/2]

Aws::Glacier::Model::InventoryRetrievalJobDescription::InventoryRetrievalJobDescription ( )

◆ InventoryRetrievalJobDescription() [2/2]

Aws::Glacier::Model::InventoryRetrievalJobDescription::InventoryRetrievalJobDescription ( Aws::Utils::Json::JsonView jsonValue )

Member Function Documentation

◆ EndDateHasBeenSet()

bool Aws::Glacier::Model::InventoryRetrievalJobDescription::EndDateHasBeenSet ( ) const

inline

The end of the date range in UTC for vault inventory retrieval that includes archives created before this date. This value should be a string in the ISO 8601 date format, for example 2013-03-20T17:03:43Z.

Definition at line 175 of file InventoryRetrievalJobDescription.h.

◆ FormatHasBeenSet()

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

inline

The output format for the vault inventory list, which is set by the InitiateJob request when initiating a job to retrieve a vault inventory. Valid values are CSV and JSON.

Definition at line 53 of file InventoryRetrievalJobDescription.h.

◆ GetEndDate()

const Aws::String& Aws::Glacier::Model::InventoryRetrievalJobDescription::GetEndDate ( ) const

inline

The end of the date range in UTC for vault inventory retrieval that includes archives created before this date. This value should be a string in the ISO 8601 date format, for example 2013-03-20T17:03:43Z.

Definition at line 168 of file InventoryRetrievalJobDescription.h.

◆ GetFormat()

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

inline

The output format for the vault inventory list, which is set by the InitiateJob request when initiating a job to retrieve a vault inventory. Valid values are CSV and JSON.

Definition at line 46 of file InventoryRetrievalJobDescription.h.

◆ GetLimit()

const Aws::String& Aws::Glacier::Model::InventoryRetrievalJobDescription::GetLimit ( ) const

inline

The maximum number of inventory items returned per vault inventory retrieval request. This limit is set when initiating the job with the a InitiateJob request.

Definition at line 225 of file InventoryRetrievalJobDescription.h.

◆ GetMarker()

const Aws::String& Aws::Glacier::Model::InventoryRetrievalJobDescription::GetMarker ( ) const

inline

An opaque string that represents where to continue pagination of the vault inventory retrieval results. You use the marker in a new InitiateJob request to obtain additional inventory items. If there are no more inventory items, this value is null. For more information, see Range Inventory Retrieval.

Definition at line 285 of file InventoryRetrievalJobDescription.h.

◆ GetStartDate()

const Aws::String& Aws::Glacier::Model::InventoryRetrievalJobDescription::GetStartDate ( ) const

inline

The start of the date range in Universal Coordinated Time (UTC) for vault inventory retrieval that includes archives created on or after this date. This value should be a string in the ISO 8601 date format, for example 2013-03-20T17:03:43Z.

Definition at line 104 of file InventoryRetrievalJobDescription.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::Glacier::Model::InventoryRetrievalJobDescription::Jsonize ( ) const

◆ LimitHasBeenSet()

bool Aws::Glacier::Model::InventoryRetrievalJobDescription::LimitHasBeenSet ( ) const

inline

The maximum number of inventory items returned per vault inventory retrieval request. This limit is set when initiating the job with the a InitiateJob request.

Definition at line 232 of file InventoryRetrievalJobDescription.h.

◆ MarkerHasBeenSet()

bool Aws::Glacier::Model::InventoryRetrievalJobDescription::MarkerHasBeenSet ( ) const

inline

An opaque string that represents where to continue pagination of the vault inventory retrieval results. You use the marker in a new InitiateJob request to obtain additional inventory items. If there are no more inventory items, this value is null. For more information, see Range Inventory Retrieval.

Definition at line 295 of file InventoryRetrievalJobDescription.h.

◆ operator=()

InventoryRetrievalJobDescription& Aws::Glacier::Model::InventoryRetrievalJobDescription::operator= ( Aws::Utils::Json::JsonView jsonValue )

◆ SetEndDate() [1/3]

void Aws::Glacier::Model::InventoryRetrievalJobDescription::SetEndDate ( const Aws::String & value )

inline

The end of the date range in UTC for vault inventory retrieval that includes archives created before this date. This value should be a string in the ISO 8601 date format, for example 2013-03-20T17:03:43Z.

Definition at line 182 of file InventoryRetrievalJobDescription.h.

◆ SetEndDate() [2/3]

void Aws::Glacier::Model::InventoryRetrievalJobDescription::SetEndDate ( Aws::String && value )

inline

The end of the date range in UTC for vault inventory retrieval that includes archives created before this date. This value should be a string in the ISO 8601 date format, for example 2013-03-20T17:03:43Z.

Definition at line 189 of file InventoryRetrievalJobDescription.h.

◆ SetEndDate() [3/3]

void Aws::Glacier::Model::InventoryRetrievalJobDescription::SetEndDate ( const char * value )

inline

The end of the date range in UTC for vault inventory retrieval that includes archives created before this date. This value should be a string in the ISO 8601 date format, for example 2013-03-20T17:03:43Z.

Definition at line 196 of file InventoryRetrievalJobDescription.h.

◆ SetFormat() [1/3]

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

inline

The output format for the vault inventory list, which is set by the InitiateJob request when initiating a job to retrieve a vault inventory. Valid values are CSV and JSON.

Definition at line 60 of file InventoryRetrievalJobDescription.h.

◆ SetFormat() [2/3]

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

inline

The output format for the vault inventory list, which is set by the InitiateJob request when initiating a job to retrieve a vault inventory. Valid values are CSV and JSON.

Definition at line 67 of file InventoryRetrievalJobDescription.h.

◆ SetFormat() [3/3]

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

inline

The output format for the vault inventory list, which is set by the InitiateJob request when initiating a job to retrieve a vault inventory. Valid values are CSV and JSON.

Definition at line 74 of file InventoryRetrievalJobDescription.h.

◆ SetLimit() [1/3]

void Aws::Glacier::Model::InventoryRetrievalJobDescription::SetLimit ( const Aws::String & value )

inline

The maximum number of inventory items returned per vault inventory retrieval request. This limit is set when initiating the job with the a InitiateJob request.

Definition at line 239 of file InventoryRetrievalJobDescription.h.

◆ SetLimit() [2/3]

void Aws::Glacier::Model::InventoryRetrievalJobDescription::SetLimit ( Aws::String && value )

inline

The maximum number of inventory items returned per vault inventory retrieval request. This limit is set when initiating the job with the a InitiateJob request.

Definition at line 246 of file InventoryRetrievalJobDescription.h.

◆ SetLimit() [3/3]

void Aws::Glacier::Model::InventoryRetrievalJobDescription::SetLimit ( const char * value )

inline

The maximum number of inventory items returned per vault inventory retrieval request. This limit is set when initiating the job with the a InitiateJob request.

Definition at line 253 of file InventoryRetrievalJobDescription.h.

◆ SetMarker() [1/3]

void Aws::Glacier::Model::InventoryRetrievalJobDescription::SetMarker ( const Aws::String & value )

inline

An opaque string that represents where to continue pagination of the vault inventory retrieval results. You use the marker in a new InitiateJob request to obtain additional inventory items. If there are no more inventory items, this value is null. For more information, see Range Inventory Retrieval.

Definition at line 305 of file InventoryRetrievalJobDescription.h.

◆ SetMarker() [2/3]

void Aws::Glacier::Model::InventoryRetrievalJobDescription::SetMarker ( Aws::String && value )

inline

An opaque string that represents where to continue pagination of the vault inventory retrieval results. You use the marker in a new InitiateJob request to obtain additional inventory items. If there are no more inventory items, this value is null. For more information, see Range Inventory Retrieval.

Definition at line 315 of file InventoryRetrievalJobDescription.h.

◆ SetMarker() [3/3]

void Aws::Glacier::Model::InventoryRetrievalJobDescription::SetMarker ( const char * value )

inline

An opaque string that represents where to continue pagination of the vault inventory retrieval results. You use the marker in a new InitiateJob request to obtain additional inventory items. If there are no more inventory items, this value is null. For more information, see Range Inventory Retrieval.

Definition at line 325 of file InventoryRetrievalJobDescription.h.

◆ SetStartDate() [1/3]

void Aws::Glacier::Model::InventoryRetrievalJobDescription::SetStartDate ( const Aws::String & value )

inline

The start of the date range in Universal Coordinated Time (UTC) for vault inventory retrieval that includes archives created on or after this date. This value should be a string in the ISO 8601 date format, for example 2013-03-20T17:03:43Z.

Definition at line 120 of file InventoryRetrievalJobDescription.h.

◆ SetStartDate() [2/3]

void Aws::Glacier::Model::InventoryRetrievalJobDescription::SetStartDate ( Aws::String && value )

inline

The start of the date range in Universal Coordinated Time (UTC) for vault inventory retrieval that includes archives created on or after this date. This value should be a string in the ISO 8601 date format, for example 2013-03-20T17:03:43Z.

Definition at line 128 of file InventoryRetrievalJobDescription.h.

◆ SetStartDate() [3/3]

void Aws::Glacier::Model::InventoryRetrievalJobDescription::SetStartDate ( const char * value )

inline

The start of the date range in Universal Coordinated Time (UTC) for vault inventory retrieval that includes archives created on or after this date. This value should be a string in the ISO 8601 date format, for example 2013-03-20T17:03:43Z.

Definition at line 136 of file InventoryRetrievalJobDescription.h.

◆ StartDateHasBeenSet()

bool Aws::Glacier::Model::InventoryRetrievalJobDescription::StartDateHasBeenSet ( ) const

inline

The start of the date range in Universal Coordinated Time (UTC) for vault inventory retrieval that includes archives created on or after this date. This value should be a string in the ISO 8601 date format, for example 2013-03-20T17:03:43Z.

Definition at line 112 of file InventoryRetrievalJobDescription.h.

◆ WithEndDate() [1/3]

InventoryRetrievalJobDescription& Aws::Glacier::Model::InventoryRetrievalJobDescription::WithEndDate ( const Aws::String & value )

inline

The end of the date range in UTC for vault inventory retrieval that includes archives created before this date. This value should be a string in the ISO 8601 date format, for example 2013-03-20T17:03:43Z.

Definition at line 203 of file InventoryRetrievalJobDescription.h.

◆ WithEndDate() [2/3]

InventoryRetrievalJobDescription& Aws::Glacier::Model::InventoryRetrievalJobDescription::WithEndDate ( Aws::String && value )

inline

The end of the date range in UTC for vault inventory retrieval that includes archives created before this date. This value should be a string in the ISO 8601 date format, for example 2013-03-20T17:03:43Z.

Definition at line 210 of file InventoryRetrievalJobDescription.h.

◆ WithEndDate() [3/3]

InventoryRetrievalJobDescription& Aws::Glacier::Model::InventoryRetrievalJobDescription::WithEndDate ( const char * value )

inline

The end of the date range in UTC for vault inventory retrieval that includes archives created before this date. This value should be a string in the ISO 8601 date format, for example 2013-03-20T17:03:43Z.

Definition at line 217 of file InventoryRetrievalJobDescription.h.

◆ WithFormat() [1/3]

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

inline

The output format for the vault inventory list, which is set by the InitiateJob request when initiating a job to retrieve a vault inventory. Valid values are CSV and JSON.

Definition at line 81 of file InventoryRetrievalJobDescription.h.

◆ WithFormat() [2/3]

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

inline

The output format for the vault inventory list, which is set by the InitiateJob request when initiating a job to retrieve a vault inventory. Valid values are CSV and JSON.

Definition at line 88 of file InventoryRetrievalJobDescription.h.

◆ WithFormat() [3/3]

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

inline

The output format for the vault inventory list, which is set by the InitiateJob request when initiating a job to retrieve a vault inventory. Valid values are CSV and JSON.

Definition at line 95 of file InventoryRetrievalJobDescription.h.

◆ WithLimit() [1/3]

InventoryRetrievalJobDescription& Aws::Glacier::Model::InventoryRetrievalJobDescription::WithLimit ( const Aws::String & value )

inline

The maximum number of inventory items returned per vault inventory retrieval request. This limit is set when initiating the job with the a InitiateJob request.

Definition at line 260 of file InventoryRetrievalJobDescription.h.

◆ WithLimit() [2/3]

InventoryRetrievalJobDescription& Aws::Glacier::Model::InventoryRetrievalJobDescription::WithLimit ( Aws::String && value )

inline

The maximum number of inventory items returned per vault inventory retrieval request. This limit is set when initiating the job with the a InitiateJob request.

Definition at line 267 of file InventoryRetrievalJobDescription.h.

◆ WithLimit() [3/3]

InventoryRetrievalJobDescription& Aws::Glacier::Model::InventoryRetrievalJobDescription::WithLimit ( const char * value )

inline

The maximum number of inventory items returned per vault inventory retrieval request. This limit is set when initiating the job with the a InitiateJob request.

Definition at line 274 of file InventoryRetrievalJobDescription.h.

◆ WithMarker() [1/3]

InventoryRetrievalJobDescription& Aws::Glacier::Model::InventoryRetrievalJobDescription::WithMarker ( const Aws::String & value )

inline

An opaque string that represents where to continue pagination of the vault inventory retrieval results. You use the marker in a new InitiateJob request to obtain additional inventory items. If there are no more inventory items, this value is null. For more information, see Range Inventory Retrieval.

Definition at line 335 of file InventoryRetrievalJobDescription.h.

◆ WithMarker() [2/3]

InventoryRetrievalJobDescription& Aws::Glacier::Model::InventoryRetrievalJobDescription::WithMarker ( Aws::String && value )

inline

An opaque string that represents where to continue pagination of the vault inventory retrieval results. You use the marker in a new InitiateJob request to obtain additional inventory items. If there are no more inventory items, this value is null. For more information, see Range Inventory Retrieval.

Definition at line 345 of file InventoryRetrievalJobDescription.h.

◆ WithMarker() [3/3]

InventoryRetrievalJobDescription& Aws::Glacier::Model::InventoryRetrievalJobDescription::WithMarker ( const char * value )

inline

An opaque string that represents where to continue pagination of the vault inventory retrieval results. You use the marker in a new InitiateJob request to obtain additional inventory items. If there are no more inventory items, this value is null. For more information, see Range Inventory Retrieval.

Definition at line 355 of file InventoryRetrievalJobDescription.h.

◆ WithStartDate() [1/3]

InventoryRetrievalJobDescription& Aws::Glacier::Model::InventoryRetrievalJobDescription::WithStartDate ( const Aws::String & value )

inline

The start of the date range in Universal Coordinated Time (UTC) for vault inventory retrieval that includes archives created on or after this date. This value should be a string in the ISO 8601 date format, for example 2013-03-20T17:03:43Z.

Definition at line 144 of file InventoryRetrievalJobDescription.h.

◆ WithStartDate() [2/3]

InventoryRetrievalJobDescription& Aws::Glacier::Model::InventoryRetrievalJobDescription::WithStartDate ( Aws::String && value )

inline

The start of the date range in Universal Coordinated Time (UTC) for vault inventory retrieval that includes archives created on or after this date. This value should be a string in the ISO 8601 date format, for example 2013-03-20T17:03:43Z.

Definition at line 152 of file InventoryRetrievalJobDescription.h.

◆ WithStartDate() [3/3]

InventoryRetrievalJobDescription& Aws::Glacier::Model::InventoryRetrievalJobDescription::WithStartDate ( const char * value )

inline

The start of the date range in Universal Coordinated Time (UTC) for vault inventory retrieval that includes archives created on or after this date. This value should be a string in the ISO 8601 date format, for example 2013-03-20T17:03:43Z.

Definition at line 160 of file InventoryRetrievalJobDescription.h.

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

aws-cpp-sdk-glacier/include/aws/glacier/model/InventoryRetrievalJobDescription.h

Public Member Functions

Detailed Description

See Also:

Constructor & Destructor Documentation

◆ InventoryRetrievalJobDescription() [1/2]

◆ InventoryRetrievalJobDescription() [2/2]

Member Function Documentation

◆ EndDateHasBeenSet()

◆ FormatHasBeenSet()

◆ GetEndDate()

◆ GetFormat()

◆ GetLimit()

◆ GetMarker()

◆ GetStartDate()

◆ Jsonize()

◆ LimitHasBeenSet()

◆ MarkerHasBeenSet()

◆ operator=()

◆ SetEndDate() [1/3]

◆ SetEndDate() [2/3]

◆ SetEndDate() [3/3]

◆ SetFormat() [1/3]

◆ SetFormat() [2/3]

◆ SetFormat() [3/3]

◆ SetLimit() [1/3]

◆ SetLimit() [2/3]

◆ SetLimit() [3/3]

◆ SetMarker() [1/3]

◆ SetMarker() [2/3]

◆ SetMarker() [3/3]

◆ SetStartDate() [1/3]

◆ SetStartDate() [2/3]

◆ SetStartDate() [3/3]

◆ StartDateHasBeenSet()

◆ WithEndDate() [1/3]

◆ WithEndDate() [2/3]

◆ WithEndDate() [3/3]

◆ WithFormat() [1/3]

◆ WithFormat() [2/3]

◆ WithFormat() [3/3]

◆ WithLimit() [1/3]

◆ WithLimit() [2/3]

◆ WithLimit() [3/3]

◆ WithMarker() [1/3]

◆ WithMarker() [2/3]

◆ WithMarker() [3/3]

◆ WithStartDate() [1/3]

◆ WithStartDate() [2/3]

◆ WithStartDate() [3/3]