Aws::Glacier::Model::ListJobsRequest Class Reference

#include <ListJobsRequest.h>

Inheritance diagram for Aws::Glacier::Model::ListJobsRequest:

Public Member Functions
	ListJobsRequest ()
virtual const char *	GetServiceRequestName () const override
Aws::String	SerializePayload () const override
void	AddQueryStringParameters (Aws::Http::URI &uri) const override
const Aws::String &	GetAccountId () const
bool	AccountIdHasBeenSet () const
void	SetAccountId (const Aws::String &value)
void	SetAccountId (Aws::String &&value)
void	SetAccountId (const char *value)
ListJobsRequest &	WithAccountId (const Aws::String &value)
ListJobsRequest &	WithAccountId (Aws::String &&value)
ListJobsRequest &	WithAccountId (const char *value)
const Aws::String &	GetVaultName () const
bool	VaultNameHasBeenSet () const
void	SetVaultName (const Aws::String &value)
void	SetVaultName (Aws::String &&value)
void	SetVaultName (const char *value)
ListJobsRequest &	WithVaultName (const Aws::String &value)
ListJobsRequest &	WithVaultName (Aws::String &&value)
ListJobsRequest &	WithVaultName (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)
ListJobsRequest &	WithLimit (const Aws::String &value)
ListJobsRequest &	WithLimit (Aws::String &&value)
ListJobsRequest &	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)
ListJobsRequest &	WithMarker (const Aws::String &value)
ListJobsRequest &	WithMarker (Aws::String &&value)
ListJobsRequest &	WithMarker (const char *value)
const Aws::String &	GetStatuscode () const
bool	StatuscodeHasBeenSet () const
void	SetStatuscode (const Aws::String &value)
void	SetStatuscode (Aws::String &&value)
void	SetStatuscode (const char *value)
ListJobsRequest &	WithStatuscode (const Aws::String &value)
ListJobsRequest &	WithStatuscode (Aws::String &&value)
ListJobsRequest &	WithStatuscode (const char *value)
const Aws::String &	GetCompleted () const
bool	CompletedHasBeenSet () const
void	SetCompleted (const Aws::String &value)
void	SetCompleted (Aws::String &&value)
void	SetCompleted (const char *value)
ListJobsRequest &	WithCompleted (const Aws::String &value)
ListJobsRequest &	WithCompleted (Aws::String &&value)
ListJobsRequest &	WithCompleted (const char *value)
Public Member Functions inherited from Aws::Glacier::GlacierRequest
virtual	~GlacierRequest ()
void	AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
Aws::Http::HeaderValueCollection	GetHeaders () const override
Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
	AmazonSerializableWebServiceRequest ()
virtual	~AmazonSerializableWebServiceRequest ()
std::shared_ptr< Aws::IOStream >	GetBody () const override
Public Member Functions inherited from Aws::AmazonWebServiceRequest
	AmazonWebServiceRequest ()
virtual	~AmazonWebServiceRequest ()=default
virtual void	PutToPresignedUrl (Aws::Http::URI &uri) const
virtual bool	IsStreaming () const
virtual bool	IsEventStreamRequest () const
virtual bool	SignBody () const
virtual bool	IsChunked () const
virtual void	SetRequestSignedHandler (const RequestSignedHandler &handler)
virtual const RequestSignedHandler &	GetRequestSignedHandler () const
const Aws::IOStreamFactory &	GetResponseStreamFactory () const
void	SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
virtual void	SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
virtual void	SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
virtual void	SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
virtual void	SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
virtual void	SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
virtual void	SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
virtual void	SetRequestRetryHandler (const RequestRetryHandler &handler)
virtual void	SetRequestRetryHandler (RequestRetryHandler &&handler)
virtual const Aws::Http::DataReceivedEventHandler &	GetDataReceivedEventHandler () const
virtual const Aws::Http::DataSentEventHandler &	GetDataSentEventHandler () const
virtual const Aws::Http::ContinueRequestHandler &	GetContinueRequestHandler () const
virtual const RequestRetryHandler &	GetRequestRetryHandler () const
virtual bool	ShouldComputeContentMd5 () const

Additional Inherited Members
Protected Member Functions inherited from Aws::Glacier::GlacierRequest
virtual Aws::Http::HeaderValueCollection	GetRequestSpecificHeaders () const
Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void	DumpBodyToUrl (Aws::Http::URI &uri) const

Detailed Description

Provides options for retrieving a job list for an Amazon S3 Glacier vault.

See Also:

AWS API Reference

Definition at line 29 of file ListJobsRequest.h.

Constructor & Destructor Documentation

ListJobsRequest()

Aws::Glacier::Model::ListJobsRequest::ListJobsRequest

(

)

Member Function Documentation

AccountIdHasBeenSet()

bool Aws::Glacier::Model::ListJobsRequest::AccountIdHasBeenSet ( ) const

inline

The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon S3 Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID.

Definition at line 61 of file ListJobsRequest.h.

AddQueryStringParameters()

void Aws::Glacier::Model::ListJobsRequest::AddQueryStringParameters ( Aws::Http::URI &  uri ) const

overridevirtual

Do nothing virtual, override this to add query strings to the request

Reimplemented from Aws::AmazonWebServiceRequest.

CompletedHasBeenSet()

bool Aws::Glacier::Model::ListJobsRequest::CompletedHasBeenSet ( ) const

inline

The state of the jobs to return. You can specify true or false.

Definition at line 340 of file ListJobsRequest.h.

GetAccountId()

const Aws::String& Aws::Glacier::Model::ListJobsRequest::GetAccountId ( ) const

inline

The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon S3 Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID.

Definition at line 52 of file ListJobsRequest.h.

GetCompleted()

const Aws::String& Aws::Glacier::Model::ListJobsRequest::GetCompleted ( ) const

inline

The state of the jobs to return. You can specify true or false.

Definition at line 334 of file ListJobsRequest.h.

GetLimit()

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

inline

The maximum number of jobs to be returned. The default limit is 50. The number of jobs returned might be fewer than the specified limit, but the number of returned jobs never exceeds the limit.

Definition at line 164 of file ListJobsRequest.h.

GetMarker()

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

inline

An opaque string used for pagination. This value specifies the job at which the listing of jobs should begin. Get the marker value from a previous List Jobs response. You only need to include the marker if you are continuing the pagination of results started in a previous List Jobs request.

Definition at line 222 of file ListJobsRequest.h.

GetServiceRequestName()

virtual const char* Aws::Glacier::Model::ListJobsRequest::GetServiceRequestName ( ) const

inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 38 of file ListJobsRequest.h.

GetStatuscode()

const Aws::String& Aws::Glacier::Model::ListJobsRequest::GetStatuscode ( ) const

inline

The type of job status to return. You can specify the following values: InProgress, Succeeded, or Failed.

Definition at line 285 of file ListJobsRequest.h.

GetVaultName()

const Aws::String& Aws::Glacier::Model::ListJobsRequest::GetVaultName ( ) const

inline

The name of the vault.

Definition at line 121 of file ListJobsRequest.h.

LimitHasBeenSet()

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

inline

The maximum number of jobs to be returned. The default limit is 50. The number of jobs returned might be fewer than the specified limit, but the number of returned jobs never exceeds the limit.

Definition at line 171 of file ListJobsRequest.h.

MarkerHasBeenSet()

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

inline

An opaque string used for pagination. This value specifies the job at which the listing of jobs should begin. Get the marker value from a previous List Jobs response. You only need to include the marker if you are continuing the pagination of results started in a previous List Jobs request.

Definition at line 230 of file ListJobsRequest.h.

SerializePayload()

Aws::String Aws::Glacier::Model::ListJobsRequest::SerializePayload ( ) const

overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

SetAccountId() [1/3]

void Aws::Glacier::Model::ListJobsRequest::SetAccountId ( const Aws::String &  value )

inline

The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon S3 Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID.

Definition at line 70 of file ListJobsRequest.h.

SetAccountId() [2/3]

void Aws::Glacier::Model::ListJobsRequest::SetAccountId ( Aws::String &&  value )

inline

The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon S3 Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID.

Definition at line 79 of file ListJobsRequest.h.

SetAccountId() [3/3]

void Aws::Glacier::Model::ListJobsRequest::SetAccountId ( const char *  value )

inline

The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon S3 Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID.

Definition at line 88 of file ListJobsRequest.h.

SetCompleted() [1/3]

void Aws::Glacier::Model::ListJobsRequest::SetCompleted ( const Aws::String &  value )

inline

The state of the jobs to return. You can specify true or false.

Definition at line 346 of file ListJobsRequest.h.

SetCompleted() [2/3]

void Aws::Glacier::Model::ListJobsRequest::SetCompleted ( Aws::String &&  value )

inline

The state of the jobs to return. You can specify true or false.

Definition at line 352 of file ListJobsRequest.h.

SetCompleted() [3/3]

void Aws::Glacier::Model::ListJobsRequest::SetCompleted ( const char *  value )

inline

The state of the jobs to return. You can specify true or false.

Definition at line 358 of file ListJobsRequest.h.

SetLimit() [1/3]

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

inline

The maximum number of jobs to be returned. The default limit is 50. The number of jobs returned might be fewer than the specified limit, but the number of returned jobs never exceeds the limit.

Definition at line 178 of file ListJobsRequest.h.

SetLimit() [2/3]

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

inline

The maximum number of jobs to be returned. The default limit is 50. The number of jobs returned might be fewer than the specified limit, but the number of returned jobs never exceeds the limit.

Definition at line 185 of file ListJobsRequest.h.

SetLimit() [3/3]

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

inline

The maximum number of jobs to be returned. The default limit is 50. The number of jobs returned might be fewer than the specified limit, but the number of returned jobs never exceeds the limit.

Definition at line 192 of file ListJobsRequest.h.

SetMarker() [1/3]

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

inline

An opaque string used for pagination. This value specifies the job at which the listing of jobs should begin. Get the marker value from a previous List Jobs response. You only need to include the marker if you are continuing the pagination of results started in a previous List Jobs request.

Definition at line 238 of file ListJobsRequest.h.

SetMarker() [2/3]

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

inline

An opaque string used for pagination. This value specifies the job at which the listing of jobs should begin. Get the marker value from a previous List Jobs response. You only need to include the marker if you are continuing the pagination of results started in a previous List Jobs request.

Definition at line 246 of file ListJobsRequest.h.

SetMarker() [3/3]

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

inline

An opaque string used for pagination. This value specifies the job at which the listing of jobs should begin. Get the marker value from a previous List Jobs response. You only need to include the marker if you are continuing the pagination of results started in a previous List Jobs request.

Definition at line 254 of file ListJobsRequest.h.

SetStatuscode() [1/3]

void Aws::Glacier::Model::ListJobsRequest::SetStatuscode ( const Aws::String &  value )

inline

The type of job status to return. You can specify the following values: InProgress, Succeeded, or Failed.

Definition at line 297 of file ListJobsRequest.h.

SetStatuscode() [2/3]

void Aws::Glacier::Model::ListJobsRequest::SetStatuscode ( Aws::String &&  value )

inline

The type of job status to return. You can specify the following values: InProgress, Succeeded, or Failed.

Definition at line 303 of file ListJobsRequest.h.

SetStatuscode() [3/3]

void Aws::Glacier::Model::ListJobsRequest::SetStatuscode ( const char *  value )

inline

The type of job status to return. You can specify the following values: InProgress, Succeeded, or Failed.

Definition at line 309 of file ListJobsRequest.h.

SetVaultName() [1/3]

void Aws::Glacier::Model::ListJobsRequest::SetVaultName ( const Aws::String &  value )

inline

The name of the vault.

Definition at line 131 of file ListJobsRequest.h.

SetVaultName() [2/3]

void Aws::Glacier::Model::ListJobsRequest::SetVaultName ( Aws::String &&  value )

inline

The name of the vault.

Definition at line 136 of file ListJobsRequest.h.

SetVaultName() [3/3]

void Aws::Glacier::Model::ListJobsRequest::SetVaultName ( const char *  value )

inline

The name of the vault.

Definition at line 141 of file ListJobsRequest.h.

StatuscodeHasBeenSet()

bool Aws::Glacier::Model::ListJobsRequest::StatuscodeHasBeenSet ( ) const

inline

The type of job status to return. You can specify the following values: InProgress, Succeeded, or Failed.

Definition at line 291 of file ListJobsRequest.h.

VaultNameHasBeenSet()

bool Aws::Glacier::Model::ListJobsRequest::VaultNameHasBeenSet ( ) const

inline

The name of the vault.

Definition at line 126 of file ListJobsRequest.h.

WithAccountId() [1/3]

ListJobsRequest& Aws::Glacier::Model::ListJobsRequest::WithAccountId ( const Aws::String &  value )

inline

The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon S3 Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID.

Definition at line 97 of file ListJobsRequest.h.

WithAccountId() [2/3]

ListJobsRequest& Aws::Glacier::Model::ListJobsRequest::WithAccountId ( Aws::String &&  value )

inline

The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon S3 Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID.

Definition at line 106 of file ListJobsRequest.h.

WithAccountId() [3/3]

ListJobsRequest& Aws::Glacier::Model::ListJobsRequest::WithAccountId ( const char *  value )

inline

The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon S3 Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID.

Definition at line 115 of file ListJobsRequest.h.

WithCompleted() [1/3]

ListJobsRequest& Aws::Glacier::Model::ListJobsRequest::WithCompleted ( const Aws::String &  value )

inline

The state of the jobs to return. You can specify true or false.

Definition at line 364 of file ListJobsRequest.h.

WithCompleted() [2/3]

ListJobsRequest& Aws::Glacier::Model::ListJobsRequest::WithCompleted ( Aws::String &&  value )

inline

The state of the jobs to return. You can specify true or false.

Definition at line 370 of file ListJobsRequest.h.

WithCompleted() [3/3]

ListJobsRequest& Aws::Glacier::Model::ListJobsRequest::WithCompleted ( const char *  value )

inline

The state of the jobs to return. You can specify true or false.

Definition at line 376 of file ListJobsRequest.h.

WithLimit() [1/3]

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

inline

The maximum number of jobs to be returned. The default limit is 50. The number of jobs returned might be fewer than the specified limit, but the number of returned jobs never exceeds the limit.

Definition at line 199 of file ListJobsRequest.h.

WithLimit() [2/3]

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

inline

The maximum number of jobs to be returned. The default limit is 50. The number of jobs returned might be fewer than the specified limit, but the number of returned jobs never exceeds the limit.

Definition at line 206 of file ListJobsRequest.h.

WithLimit() [3/3]

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

inline

The maximum number of jobs to be returned. The default limit is 50. The number of jobs returned might be fewer than the specified limit, but the number of returned jobs never exceeds the limit.

Definition at line 213 of file ListJobsRequest.h.

WithMarker() [1/3]

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

inline

An opaque string used for pagination. This value specifies the job at which the listing of jobs should begin. Get the marker value from a previous List Jobs response. You only need to include the marker if you are continuing the pagination of results started in a previous List Jobs request.

Definition at line 262 of file ListJobsRequest.h.

WithMarker() [2/3]

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

inline

An opaque string used for pagination. This value specifies the job at which the listing of jobs should begin. Get the marker value from a previous List Jobs response. You only need to include the marker if you are continuing the pagination of results started in a previous List Jobs request.

Definition at line 270 of file ListJobsRequest.h.

WithMarker() [3/3]

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

inline

An opaque string used for pagination. This value specifies the job at which the listing of jobs should begin. Get the marker value from a previous List Jobs response. You only need to include the marker if you are continuing the pagination of results started in a previous List Jobs request.

Definition at line 278 of file ListJobsRequest.h.

WithStatuscode() [1/3]

ListJobsRequest& Aws::Glacier::Model::ListJobsRequest::WithStatuscode ( const Aws::String &  value )

inline

The type of job status to return. You can specify the following values: InProgress, Succeeded, or Failed.

Definition at line 315 of file ListJobsRequest.h.

WithStatuscode() [2/3]

ListJobsRequest& Aws::Glacier::Model::ListJobsRequest::WithStatuscode ( Aws::String &&  value )

inline

The type of job status to return. You can specify the following values: InProgress, Succeeded, or Failed.

Definition at line 321 of file ListJobsRequest.h.

WithStatuscode() [3/3]

ListJobsRequest& Aws::Glacier::Model::ListJobsRequest::WithStatuscode ( const char *  value )

inline

The type of job status to return. You can specify the following values: InProgress, Succeeded, or Failed.

Definition at line 327 of file ListJobsRequest.h.

WithVaultName() [1/3]

ListJobsRequest& Aws::Glacier::Model::ListJobsRequest::WithVaultName ( const Aws::String &  value )

inline

The name of the vault.

Definition at line 146 of file ListJobsRequest.h.

WithVaultName() [2/3]

ListJobsRequest& Aws::Glacier::Model::ListJobsRequest::WithVaultName ( Aws::String &&  value )

inline

The name of the vault.

Definition at line 151 of file ListJobsRequest.h.

WithVaultName() [3/3]

ListJobsRequest& Aws::Glacier::Model::ListJobsRequest::WithVaultName ( const char *  value )

inline

The name of the vault.

Definition at line 156 of file ListJobsRequest.h.

---

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

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