public static interface ListJobsRequest.Builder extends BatchRequest.Builder, CopyableBuilder<ListJobsRequest.Builder,ListJobsRequest>
Modifier and Type | Method and Description |
---|---|
ListJobsRequest.Builder |
jobQueue(String jobQueue)
The name or full Amazon Resource Name (ARN) of the job queue with which to list jobs.
|
ListJobsRequest.Builder |
jobStatus(JobStatus jobStatus)
The job status with which to filter jobs in the specified queue.
|
ListJobsRequest.Builder |
jobStatus(String jobStatus)
The job status with which to filter jobs in the specified queue.
|
ListJobsRequest.Builder |
maxResults(Integer maxResults)
The maximum number of results returned by
ListJobs in paginated output. |
ListJobsRequest.Builder |
nextToken(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. |
ListJobsRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
Add an optional request override configuration.
|
ListJobsRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
Add an optional request override configuration.
|
build
overrideConfiguration
copy
applyMutation, build
ListJobsRequest.Builder jobQueue(String jobQueue)
The name or full Amazon Resource Name (ARN) of the job queue with which to list jobs.
jobQueue
- The name or full Amazon Resource Name (ARN) of the job queue with which to list jobs.ListJobsRequest.Builder jobStatus(String 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.
ListJobsRequest.Builder jobStatus(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.
ListJobsRequest.Builder maxResults(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.
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.ListJobsRequest.Builder nextToken(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
- 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.
ListJobsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
AwsRequest.Builder
overrideConfiguration
in interface AwsRequest.Builder
overrideConfiguration
- The override configuration.ListJobsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
AwsRequest.Builder
overrideConfiguration
in interface AwsRequest.Builder
builderConsumer
- A Consumer
to which an empty AwsRequestOverrideConfiguration.Builder
will be
given.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.