@Generated(value="software.amazon.awssdk:codegen") public final class ListJobsRequest extends BatchRequest implements ToCopyableBuilder<ListJobsRequest.Builder,ListJobsRequest>
Contains the parameters for ListJobs.
| Modifier and Type | Class and Description |
|---|---|
static interface |
ListJobsRequest.Builder |
| Modifier and Type | Method and Description |
|---|---|
String |
arrayJobId()
The job ID for an array job.
|
static ListJobsRequest.Builder |
builder() |
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
String |
jobQueue()
The name or full Amazon Resource Name (ARN) of the job queue used to list jobs.
|
JobStatus |
jobStatus()
The job status used to filter jobs in the specified queue.
|
String |
jobStatusAsString()
The job status used to filter jobs in the specified queue.
|
Integer |
maxResults()
The maximum number of results returned by
ListJobs in paginated output. |
String |
multiNodeJobId()
The job ID for a multi-node parallel job.
|
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. |
List<SdkField<?>> |
sdkFields() |
static Class<? extends ListJobsRequest.Builder> |
serializableBuilderClass() |
ListJobsRequest.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
overrideConfigurationclone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final String jobQueue()
The name or full Amazon Resource Name (ARN) of the job queue used to list jobs.
public final String arrayJobId()
The job ID for an array job. Specifying an array job ID with this parameter lists all child jobs from within the specified array.
public final String multiNodeJobId()
The job ID for a multi-node parallel job. Specifying a multi-node parallel job ID with this parameter lists all nodes that are associated with the specified job.
public final JobStatus jobStatus()
The job status used to filter jobs in the specified queue. If you don't 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 final String jobStatusAsString()
The job status used to filter jobs in the specified queue. If you don't 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 final 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 and 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 isn't 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 and 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 isn't used, then ListJobs returns up to 100
results and a nextToken value if applicable.public final 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's 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's only used to retrieve the next items in a list and not for other programmatic purposes.
public ListJobsRequest.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<ListJobsRequest.Builder,ListJobsRequest>toBuilder in class BatchRequestpublic static ListJobsRequest.Builder builder()
public static Class<? extends ListJobsRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsRequestpublic final boolean equals(Object obj)
equals in class AwsRequestpublic final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField in class SdkRequestCopyright © 2021. All rights reserved.