software.amazon.awssdk.services.batch.model

Interface ListJobsRequest.Builder

All Superinterfaces:

AwsRequest.Builder, BatchRequest.Builder, Buildable, CopyableBuilder<ListJobsRequest.Builder,ListJobsRequest>, SdkBuilder<ListJobsRequest.Builder,ListJobsRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

ListJobsRequest

public static interface ListJobsRequest.Builder
extends BatchRequest.Builder, SdkPojo, CopyableBuilder<ListJobsRequest.Builder,ListJobsRequest>

Method Summary

Modifier and Type	Method and Description
ListJobsRequest.Builder	arrayJobId(String arrayJobId) The job ID for an array job.
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	multiNodeJobId(String multiNodeJobId) The job ID for a multi-node parallel job.
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)
ListJobsRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Methods inherited from interface software.amazon.awssdk.services.batch.model.BatchRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

jobQueue

ListJobsRequest.Builder jobQueue(String jobQueue)

The name or full Amazon Resource Name (ARN) of the job queue with which to list jobs.

Parameters:

jobQueue - The name or full Amazon Resource Name (ARN) of the job queue with which to list jobs.

Returns:

Returns a reference to this object so that method calls can be chained together.

arrayJobId

ListJobsRequest.Builder arrayJobId(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

multiNodeJobId

ListJobsRequest.Builder multiNodeJobId(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

jobStatus

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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

JobStatus, JobStatus

jobStatus

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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

JobStatus, JobStatus

maxResults

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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

nextToken

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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

overrideConfiguration

ListJobsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

ListJobsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder