com.amazonaws.services.glacier.model
Class ListJobsRequest

java.lang.Object
  com.amazonaws.AmazonWebServiceRequest
      com.amazonaws.services.glacier.model.ListJobsRequest

All Implemented Interfaces:

Serializable

public class ListJobsRequest
extends AmazonWebServiceRequest
implements Serializable

Container for the parameters to the ListJobs operation.

This operation lists jobs for a vault, including jobs that are in-progress and jobs that have recently finished.

NOTE: Amazon Glacier retains recently completed jobs for a period before deleting them; however, it eventually removes completed jobs. The output of completed jobs can be retrieved. Retaining completed jobs for a period of time after they have completed enables you to get a job output in the event you miss the job completion notification or your first attempt to download it fails. For example, suppose you start an archive retrieval job to download an archive. After the job completes, you start to download the archive but encounter a network error. In this scenario, you can retry and download the archive while the job exists.

To retrieve an archive or retrieve a vault inventory from Amazon Glacier, you first initiate a job, and after the job completes, you download the data. For an archive retrieval, the output is the archive data, and for an inventory retrieval, it is the inventory list. The List Job operation returns a list of these jobs sorted by job initiation time.

This List Jobs operation supports pagination. By default, this operation returns up to 1,000 jobs in the response. You should always check the response for a marker at which to continue the list; if there are no more items the marker is null . To return a list of jobs that begins at a specific job, set the marker request parameter to the value you obtained from a previous List Jobs request. You can also limit the number of jobs returned in the response by specifying the limit parameter in the request.

Additionally, you can filter the jobs list returned by specifying an optional statuscode (InProgress, Succeeded, or Failed) and completed (true, false) parameter. The statuscode allows you to specify that only jobs that match a specified status are returned. The completed parameter allows you to specify that only jobs in a specific completion state are returned.

An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM) .

For the underlying REST API, go to List Jobs

See Also:

AmazonGlacier.listJobs(ListJobsRequest), Serialized Form

Constructor Summary

ListJobsRequest()
Default constructor for a new ListJobsRequest object.

ListJobsRequest(String vaultName)
Constructs a new ListJobsRequest object.

ListJobsRequest(String accountId, String vaultName)
Constructs a new ListJobsRequest object.

Method Summary

boolean	equals(Object obj)
String	getAccountId() The AccountId is the AWS Account ID.
String	getCompleted() Specifies the state of the jobs to return.
String	getLimit() Specifies that the response be limited to the specified number of items or fewer.
String	getMarker() An opaque string used for pagination.
String	getStatuscode() Specifies the type of job status to return.
String	getVaultName() The name of the vault.
int	hashCode()
void	setAccountId(String accountId) The AccountId is the AWS Account ID.
void	setCompleted(String completed) Specifies the state of the jobs to return.
void	setLimit(String limit) Specifies that the response be limited to the specified number of items or fewer.
void	setMarker(String marker) An opaque string used for pagination.
void	setStatuscode(String statuscode) Specifies the type of job status to return.
void	setVaultName(String vaultName) The name of the vault.
String	toString() Returns a string representation of this object; useful for testing and debugging.
ListJobsRequest	withAccountId(String accountId) The AccountId is the AWS Account ID.
ListJobsRequest	withCompleted(String completed) Specifies the state of the jobs to return.
ListJobsRequest	withLimit(String limit) Specifies that the response be limited to the specified number of items or fewer.
ListJobsRequest	withMarker(String marker) An opaque string used for pagination.
ListJobsRequest	withStatuscode(String statuscode) Specifies the type of job status to return.
ListJobsRequest	withVaultName(String vaultName) The name of the vault.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, setRequestCredentials

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ListJobsRequest

public ListJobsRequest()

Default constructor for a new ListJobsRequest object. Callers should use the setter or fluent setter (with...) methods to initialize this object after creating it.

ListJobsRequest

public ListJobsRequest(String vaultName)

Constructs a new ListJobsRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.

Parameters:

vaultName - The name of the vault.

ListJobsRequest

public ListJobsRequest(String accountId,
                       String vaultName)

Constructs a new ListJobsRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.

Parameters:

accountId - The AccountId is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', in which case Amazon Glacier uses the AWS Account ID associated with the credentials used to sign the request. If you specify your Account ID, do not include hyphens in it.

vaultName - The name of the vault.

Method Detail

getAccountId

public String getAccountId()

The AccountId is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', in which case Amazon Glacier uses the AWS Account ID associated with the credentials used to sign the request. If you specify your Account ID, do not include hyphens in it.

Returns:

The AccountId is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', in which case Amazon Glacier uses the AWS Account ID associated with the credentials used to sign the request. If you specify your Account ID, do not include hyphens in it.

setAccountId

public void setAccountId(String accountId)

The AccountId is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', in which case Amazon Glacier uses the AWS Account ID associated with the credentials used to sign the request. If you specify your Account ID, do not include hyphens in it.

Parameters:

accountId - The AccountId is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', in which case Amazon Glacier uses the AWS Account ID associated with the credentials used to sign the request. If you specify your Account ID, do not include hyphens in it.

withAccountId

public ListJobsRequest withAccountId(String accountId)

The AccountId is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', in which case Amazon Glacier uses the AWS Account ID associated with the credentials used to sign the request. If you specify your Account ID, do not include hyphens in it.

Returns a reference to this object so that method calls can be chained together.

Parameters:

accountId - The AccountId is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', in which case Amazon Glacier uses the AWS Account ID associated with the credentials used to sign the request. If you specify your Account ID, do not include hyphens in it.

Returns:

A reference to this updated object so that method calls can be chained together.

getVaultName

public String getVaultName()

The name of the vault.

Returns:

The name of the vault.

setVaultName

public void setVaultName(String vaultName)

The name of the vault.

Parameters:

vaultName - The name of the vault.

withVaultName

public ListJobsRequest withVaultName(String vaultName)

The name of the vault.

Returns a reference to this object so that method calls can be chained together.

Parameters:

vaultName - The name of the vault.

Returns:

A reference to this updated object so that method calls can be chained together.

getLimit

public String getLimit()

Specifies that the response be limited to the specified number of items or fewer. If not specified, the List Jobs operation returns up to 1,000 jobs.

Returns:

Specifies that the response be limited to the specified number of items or fewer. If not specified, the List Jobs operation returns up to 1,000 jobs.

setLimit

public void setLimit(String limit)

Specifies that the response be limited to the specified number of items or fewer. If not specified, the List Jobs operation returns up to 1,000 jobs.

Parameters:

limit - Specifies that the response be limited to the specified number of items or fewer. If not specified, the List Jobs operation returns up to 1,000 jobs.

withLimit

public ListJobsRequest withLimit(String limit)

Specifies that the response be limited to the specified number of items or fewer. If not specified, the List Jobs operation returns up to 1,000 jobs.

Returns a reference to this object so that method calls can be chained together.

Parameters:

limit - Specifies that the response be limited to the specified number of items or fewer. If not specified, the List Jobs operation returns up to 1,000 jobs.

Returns:

A reference to this updated object so that method calls can be chained together.

getMarker

public String getMarker()

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 need only include the marker if you are continuing the pagination of results started in a previous List Jobs request.

Returns:

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 need only include the marker if you are continuing the pagination of results started in a previous List Jobs request.

setMarker

public void setMarker(String marker)

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 need only include the marker if you are continuing the pagination of results started in a previous List Jobs request.

Parameters:

marker - 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 need only include the marker if you are continuing the pagination of results started in a previous List Jobs request.

withMarker

public ListJobsRequest withMarker(String marker)

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 need only include the marker if you are continuing the pagination of results started in a previous List Jobs request.

Returns a reference to this object so that method calls can be chained together.

Parameters:

marker - 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 need only include the marker if you are continuing the pagination of results started in a previous List Jobs request.

Returns:

A reference to this updated object so that method calls can be chained together.

getStatuscode

public String getStatuscode()

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

Returns:

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

setStatuscode

public void setStatuscode(String statuscode)

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

Parameters:

statuscode - Specifies the type of job status to return. You can specify the following values: "InProgress", "Succeeded", or "Failed".

withStatuscode

public ListJobsRequest withStatuscode(String statuscode)

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

Returns a reference to this object so that method calls can be chained together.

Parameters:

statuscode - Specifies the type of job status to return. You can specify the following values: "InProgress", "Succeeded", or "Failed".

Returns:

A reference to this updated object so that method calls can be chained together.

getCompleted

public String getCompleted()

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

Returns:

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

setCompleted

public void setCompleted(String completed)

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

Parameters:

completed - Specifies the state of the jobs to return. You can specify true or false.

withCompleted

public ListJobsRequest withCompleted(String completed)

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

Returns a reference to this object so that method calls can be chained together.

Parameters:

completed - Specifies the state of the jobs to return. You can specify true or false.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object