@Generated(value="software.amazon.awssdk:codegen") public class ListJobsRequest extends BatchRequest implements ToCopyableBuilder<ListJobsRequest.Builder,ListJobsRequest>
| Modifier and Type | Class and Description |
|---|---|
static interface |
ListJobsRequest.Builder |
| Modifier and Type | Method and Description |
|---|---|
static ListJobsRequest.Builder |
builder() |
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 |
jobQueue()
The name or full Amazon Resource Name (ARN) of the job queue with which to list jobs.
|
JobStatus |
jobStatus()
The job status with which to filter jobs in the specified queue.
|
String |
jobStatusAsString()
The job status with which to filter jobs in the specified queue.
|
Integer |
maxResults()
The maximum number of results returned by
ListJobs in paginated output. |
String |
nextToken()
The
nextToken value returned from a previous paginated ListJobs request where
maxResults was used and the results exceeded the value of that parameter. |
static Class<? extends ListJobsRequest.Builder> |
serializableBuilderClass() |
ListJobsRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
requestOverrideConfigcopypublic String jobQueue()
The name or full Amazon Resource Name (ARN) of the job queue with which to list jobs.
public JobStatus jobStatus()
The job status with which to filter jobs in the specified queue. If you do not specify a status, only
RUNNING jobs are returned.
If the service returns an enum value that is not available in the current SDK version, jobStatus will
return JobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from
jobStatusAsString().
RUNNING jobs are returned.JobStatuspublic String jobStatusAsString()
The job status with which to filter jobs in the specified queue. If you do not specify a status, only
RUNNING jobs are returned.
If the service returns an enum value that is not available in the current SDK version, jobStatus will
return JobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from
jobStatusAsString().
RUNNING jobs are returned.JobStatuspublic Integer maxResults()
The maximum number of results returned by ListJobs in paginated output. When this parameter is used,
ListJobs only returns maxResults results in a single page along with a
nextToken response element. The remaining results of the initial request can be seen by sending
another ListJobs request with the returned nextToken value. This value can be between 1
and 100. If this parameter is not used, then ListJobs returns up to 100 results and a
nextToken value if applicable.
ListJobs in paginated output. When this parameter
is used, ListJobs only returns maxResults results in a single page along with a
nextToken response element. The remaining results of the initial request can be seen by
sending another ListJobs request with the returned nextToken value. This value
can be between 1 and 100. If this parameter is not used, then ListJobs returns up to 100
results and a nextToken value if applicable.public String nextToken()
The nextToken value returned from a previous paginated ListJobs request where
maxResults was used and the results exceeded the value of that parameter. Pagination continues from
the end of the previous results that returned the nextToken value. This value is null
when there are no more results to return.
This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
nextToken value returned from a previous paginated ListJobs request where
maxResults was used and the results exceeded the value of that parameter. Pagination
continues from the end of the previous results that returned the nextToken value. This value
is null when there are no more results to return. This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
public ListJobsRequest.Builder toBuilder()
ToCopyableBuildertoBuilder in interface ToCopyableBuilder<ListJobsRequest.Builder,ListJobsRequest>toBuilder in class BatchRequestpublic static ListJobsRequest.Builder builder()
public static Class<? extends ListJobsRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequestSdkRequest. 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 SdkRequestfieldName - 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.