@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 S3 Glacier vault.
NOOP
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.
|
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.
|
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.
|
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
public ListJobsRequest()
public ListJobsRequest(String vaultName)
vaultName
- The name of the vault.public ListJobsRequest(String accountId, 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 '-
' (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.vaultName
- The name of the vault.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 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.
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 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.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 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.
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.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 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.
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 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.public void setVaultName(String vaultName)
The name of the vault.
vaultName
- The name of the vault.public String getVaultName()
The name of the vault.
public ListJobsRequest withVaultName(String vaultName)
The name of the vault.
vaultName
- The name of the vault.public void setLimit(String limit)
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.
limit
- 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.public String getLimit()
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.
public ListJobsRequest withLimit(String limit)
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.
limit
- 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.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.
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.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.
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.
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.public void setStatuscode(String statuscode)
The type of job status to return. You can specify the following values: InProgress
,
Succeeded
, or Failed
.
statuscode
- The type of job status to return. You can specify the following values: InProgress
,
Succeeded
, or Failed
.public String getStatuscode()
The type of job status to return. You can specify the following values: InProgress
,
Succeeded
, or Failed
.
InProgress
,
Succeeded
, or Failed
.public ListJobsRequest withStatuscode(String statuscode)
The type of job status to return. You can specify the following values: InProgress
,
Succeeded
, or Failed
.
statuscode
- The type of job status to return. You can specify the following values: InProgress
,
Succeeded
, or Failed
.public void setCompleted(String completed)
The state of the jobs to return. You can specify true
or false
.
completed
- The state of the jobs to return. You can specify true
or false
.public String getCompleted()
The state of the jobs to return. You can specify true
or false
.
true
or false
.public ListJobsRequest withCompleted(String completed)
The state of the jobs to return. You can specify true
or false
.
completed
- The state of the jobs to return. You can specify true
or false
.public String toString()
toString
in class Object
Object.toString()
public ListJobsRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()