@Generated(value="software.amazon.awssdk:codegen") public final class ListJobsRequest extends GlacierRequest implements ToCopyableBuilder<ListJobsRequest.Builder,ListJobsRequest>
Provides options for retrieving a job list for an Amazon Glacier vault.
Modifier and Type | Class and Description |
---|---|
static interface |
ListJobsRequest.Builder |
Modifier and Type | Method and Description |
---|---|
String |
accountId()
The
AccountId value is the AWS account ID of the account that owns the vault. |
static ListJobsRequest.Builder |
builder() |
String |
completed()
The state of the jobs to return.
|
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
int |
hashCode() |
String |
limit()
The maximum number of jobs to be returned.
|
String |
marker()
An opaque string used for pagination.
|
static Class<? extends ListJobsRequest.Builder> |
serializableBuilderClass() |
String |
statuscode()
The type of job status to return.
|
ListJobsRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
String |
vaultName()
The name of the vault.
|
overrideConfiguration
copy
public 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.
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.public String vaultName()
The name of the vault.
public 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.
public 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.
public String statuscode()
The type of job status to return. You can specify the following values: InProgress
,
Succeeded
, or Failed
.
InProgress
,
Succeeded
, or Failed
.public String completed()
The state of the jobs to return. You can specify true
or false
.
true
or false
.public ListJobsRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<ListJobsRequest.Builder,ListJobsRequest>
toBuilder
in class GlacierRequest
public static ListJobsRequest.Builder builder()
public static Class<? extends ListJobsRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.