public class ListJobsRequest extends AmazonWebServiceRequest implements java.io.Serializable, java.lang.Cloneable
Provides options for retrieving a job list for an Amazon Glacier vault.
Modifier and Type | Field and Description |
---|---|
private java.lang.String |
accountId
The
AccountId value is the AWS account ID of the account
that owns the vault. |
private java.lang.String |
completed
Specifies the state of the jobs to return.
|
private java.lang.String |
limit
Specifies that the response be limited to the specified number of items
or fewer.
|
private java.lang.String |
marker
An opaque string used for pagination.
|
private java.lang.String |
statuscode
Specifies the type of job status to return.
|
private java.lang.String |
vaultName
The name of the vault.
|
NOOP
Constructor and Description |
---|
ListJobsRequest()
Default constructor for ListJobsRequest object.
|
ListJobsRequest(java.lang.String vaultName)
Constructs a new ListJobsRequest object.
|
ListJobsRequest(java.lang.String accountId,
java.lang.String vaultName)
Constructs a new ListJobsRequest object.
|
Modifier and Type | Method and Description |
---|---|
ListJobsRequest |
clone()
Creates a shallow clone of this request.
|
boolean |
equals(java.lang.Object obj) |
java.lang.String |
getAccountId()
The
AccountId value is the AWS account ID of the account
that owns the vault. |
java.lang.String |
getCompleted()
Specifies the state of the jobs to return.
|
java.lang.String |
getLimit()
Specifies that the response be limited to the specified number of items
or fewer.
|
java.lang.String |
getMarker()
An opaque string used for pagination.
|
java.lang.String |
getStatuscode()
Specifies the type of job status to return.
|
java.lang.String |
getVaultName()
The name of the vault.
|
int |
hashCode() |
void |
setAccountId(java.lang.String accountId)
The
AccountId value is the AWS account ID of the account
that owns the vault. |
void |
setCompleted(java.lang.String completed)
Specifies the state of the jobs to return.
|
void |
setLimit(java.lang.String limit)
Specifies that the response be limited to the specified number of items
or fewer.
|
void |
setMarker(java.lang.String marker)
An opaque string used for pagination.
|
void |
setStatuscode(java.lang.String statuscode)
Specifies the type of job status to return.
|
void |
setVaultName(java.lang.String vaultName)
The name of the vault.
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
ListJobsRequest |
withAccountId(java.lang.String accountId)
The
AccountId value is the AWS account ID of the account
that owns the vault. |
ListJobsRequest |
withCompleted(java.lang.String completed)
Specifies the state of the jobs to return.
|
ListJobsRequest |
withLimit(java.lang.String limit)
Specifies that the response be limited to the specified number of items
or fewer.
|
ListJobsRequest |
withMarker(java.lang.String marker)
An opaque string used for pagination.
|
ListJobsRequest |
withStatuscode(java.lang.String statuscode)
Specifies the type of job status to return.
|
ListJobsRequest |
withVaultName(java.lang.String vaultName)
The name of the vault.
|
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
private java.lang.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 apos-
apos (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
(apos-apos) in the ID.
private java.lang.String vaultName
The name of the vault.
private java.lang.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.
private java.lang.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.
private java.lang.String statuscode
Specifies the type of job status to return. You can specify the following values: "InProgress", "Succeeded", or "Failed".
private java.lang.String completed
Specifies the state of the jobs to return. You can specify
true
or false
.
public ListJobsRequest()
public ListJobsRequest(java.lang.String vaultName)
vaultName
- The name of the vault.public ListJobsRequest(java.lang.String accountId, java.lang.String vaultName)
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 apos-
apos (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 (apos-apos) in the ID.vaultName
- The name of the vault.public void setAccountId(java.lang.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 apos-
apos (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
(apos-apos) in the ID.
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 apos-
apos (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 (apos-apos) in the ID.public java.lang.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 apos-
apos (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
(apos-apos) in the ID.
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 apos-
apos
(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 (apos-apos) in the
ID.public ListJobsRequest withAccountId(java.lang.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 apos-
apos (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
(apos-apos) in the ID.
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 apos-
apos (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 (apos-apos) in the ID.public void setVaultName(java.lang.String vaultName)
The name of the vault.
vaultName
- The name of the vault.public java.lang.String getVaultName()
The name of the vault.
public ListJobsRequest withVaultName(java.lang.String vaultName)
The name of the vault.
vaultName
- The name of the vault.public void setLimit(java.lang.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.
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.public java.lang.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.
public ListJobsRequest withLimit(java.lang.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.
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.public void setMarker(java.lang.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.
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.public java.lang.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.
public ListJobsRequest withMarker(java.lang.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.
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.public void setStatuscode(java.lang.String statuscode)
Specifies the type of job status to return. You can specify the following values: "InProgress", "Succeeded", or "Failed".
statuscode
- Specifies the type of job status to return. You can specify the
following values: "InProgress", "Succeeded", or "Failed".public java.lang.String getStatuscode()
Specifies the type of job status to return. You can specify the following values: "InProgress", "Succeeded", or "Failed".
public ListJobsRequest withStatuscode(java.lang.String statuscode)
Specifies the type of job status to return. You can specify the following values: "InProgress", "Succeeded", or "Failed".
statuscode
- Specifies the type of job status to return. You can specify the
following values: "InProgress", "Succeeded", or "Failed".public void setCompleted(java.lang.String completed)
Specifies the state of the jobs to return. You can specify
true
or false
.
completed
- Specifies the state of the jobs to return. You can specify
true
or false
.public java.lang.String getCompleted()
Specifies the state of the jobs to return. You can specify
true
or false
.
true
or false
.public ListJobsRequest withCompleted(java.lang.String completed)
Specifies the state of the jobs to return. You can specify
true
or false
.
completed
- Specifies the state of the jobs to return. You can specify
true
or false
.public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public ListJobsRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()