com.amazonaws.services.glacier.model

Class ListJobsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.glacier.model.ListJobsRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ListJobsRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

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

See Also:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
ListJobsRequest() Default constructor for ListJobsRequest object.
ListJobsRequest(String vaultName) Constructs a new ListJobsRequest object.
ListJobsRequest(String accountId, String vaultName) Constructs a new ListJobsRequest object.

Method Summary

Modifier and Type	Method and Description
ListJobsRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getAccountId() The AccountId value is the AWS account ID of the account that owns the vault.
String	getCompleted() The state of the jobs to return.
String	getLimit() The maximum number of jobs to be returned.
String	getMarker() An opaque string used for pagination.
String	getStatuscode() The type of job status to return.
String	getVaultName() The name of the vault.
int	hashCode()
void	setAccountId(String accountId) The AccountId value is the AWS account ID of the account that owns the vault.
void	setCompleted(String completed) The state of the jobs to return.
void	setLimit(String limit) The maximum number of jobs to be returned.
void	setMarker(String marker) An opaque string used for pagination.
void	setStatuscode(String statuscode) 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 value is the AWS account ID of the account that owns the vault.
ListJobsRequest	withCompleted(String completed) The state of the jobs to return.
ListJobsRequest	withLimit(String limit) The maximum number of jobs to be returned.
ListJobsRequest	withMarker(String marker) An opaque string used for pagination.
ListJobsRequest	withStatuscode(String statuscode) The type of job status to return.
ListJobsRequest	withVaultName(String vaultName) The name of the vault.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ListJobsRequest

public ListJobsRequest()

Default constructor for ListJobsRequest object. Callers should use the setter or fluent setter (with...) methods to initialize the 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 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 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.

vaultName - The name of the vault.

Method Detail

setAccountId

public void setAccountId(String accountId)

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 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.

Parameters:

accountId - 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 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.

getAccountId

public String getAccountId()

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 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.

Returns:

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 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.

withAccountId

public ListJobsRequest withAccountId(String accountId)

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 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.

Parameters:

accountId - 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 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.

Returns:

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

setVaultName

public void setVaultName(String vaultName)

The name of the vault.

Parameters:

vaultName - The name of the vault.

getVaultName

public String getVaultName()

The name of the vault.

Returns:

The name of the vault.

withVaultName

public ListJobsRequest withVaultName(String vaultName)

The name of the vault.

Parameters:

vaultName - The name of the vault.

Returns:

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

setLimit

public void setLimit(String limit)

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

Parameters:

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

getLimit

public String getLimit()

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

Returns:

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

withLimit

public ListJobsRequest withLimit(String limit)

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

Parameters:

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

Returns:

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

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

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

Returns:

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

setStatuscode

public void setStatuscode(String statuscode)

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

Parameters:

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

getStatuscode

public String getStatuscode()

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

Returns:

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

withStatuscode

public ListJobsRequest withStatuscode(String statuscode)

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

Parameters:

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

Returns:

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

setCompleted

public void setCompleted(String completed)

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

Parameters:

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

getCompleted

public String getCompleted()

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

Returns:

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

withCompleted

public ListJobsRequest withCompleted(String completed)

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

Parameters:

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

Returns:

Returns a reference to this 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()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public ListJobsRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()