Class ListJobsRequest
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
Provides options for retrieving a job list for an Amazon Glacier vault.
- See Also:
-
Field Summary
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
Constructor Summary
ConstructorsConstructorDescriptionDefault 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 TypeMethodDescriptionclone()
Creates a shallow clone of this request.boolean
TheAccountId
value is the AWS account ID of the account that owns the vault.Specifies the state of the jobs to return.getLimit()
Specifies that the response be limited to the specified number of items or fewer.An opaque string used for pagination.Specifies the type of job status to return.The name of the vault.int
hashCode()
void
setAccountId
(String accountId) TheAccountId
value is the AWS account ID of the account that owns the vault.void
setCompleted
(String completed) Specifies the state of the jobs to return.void
Specifies that the response be limited to the specified number of items or fewer.void
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.toString()
Returns a string representation of this object; useful for testing and debugging.withAccountId
(String accountId) TheAccountId
value is the AWS account ID of the account that owns the vault.withCompleted
(String completed) Specifies the state of the jobs to return.Specifies that the response be limited to the specified number of items or fewer.withMarker
(String marker) An opaque string used for pagination.withStatuscode
(String statuscode) Specifies the type of job status to return.withVaultName
(String vaultName) The name of the vault.Methods inherited from class com.amazonaws.AmazonWebServiceRequest
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
-
Constructor Details
-
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
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
Constructs a new ListJobsRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.- Parameters:
accountId
- TheAccountId
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.
-
-
Method Details
-
setAccountId
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.- Parameters:
accountId
- TheAccountId
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.
-
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.- 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 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.
-
withAccountId
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.- Parameters:
accountId
- TheAccountId
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setVaultName
The name of the vault.
- Parameters:
vaultName
- The name of the vault.
-
getVaultName
The name of the vault.
- Returns:
- The name of the vault.
-
withVaultName
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
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.
-
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.
-
withLimit
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setMarker
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.
-
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.
-
withMarker
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setStatuscode
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".
-
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".
-
withStatuscode
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".- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setCompleted
Specifies the state of the jobs to return. You can specify
true
orfalse
.- Parameters:
completed
- Specifies the state of the jobs to return. You can specifytrue
orfalse
.
-
getCompleted
Specifies the state of the jobs to return. You can specify
true
orfalse
.- Returns:
- Specifies the state of the jobs to return. You can specify
true
orfalse
.
-
withCompleted
Specifies the state of the jobs to return. You can specify
true
orfalse
.- Parameters:
completed
- Specifies the state of the jobs to return. You can specifytrue
orfalse
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
Description copied from class:AmazonWebServiceRequest
Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.- Overrides:
clone
in classAmazonWebServiceRequest
- See Also:
-