Package software.amazon.awssdk.services.batch.model

Interface DescribeJobQueuesRequest.Builder

All Superinterfaces:

CopyableBuilder<DescribeJobQueuesRequest.Builder,DescribeJobQueuesRequest>, SdkBuilder<DescribeJobQueuesRequest.Builder,DescribeJobQueuesRequest>

Enclosing class:

DescribeJobQueuesRequest

public static interface DescribeJobQueuesRequest.Builder
extends CopyableBuilder<DescribeJobQueuesRequest.Builder,DescribeJobQueuesRequest>

Method Summary

Modifier and Type	Method	Description
DescribeJobQueuesRequest.Builder	jobQueues(String... jobQueues)	A list of up to 100 queue names or full queue Amazon Resource Name (ARN) entries.
DescribeJobQueuesRequest.Builder	jobQueues(Collection<String> jobQueues)	A list of up to 100 queue names or full queue Amazon Resource Name (ARN) entries.
DescribeJobQueuesRequest.Builder	maxResults(Integer maxResults)	The maximum number of results returned by DescribeJobQueues in paginated output.
DescribeJobQueuesRequest.Builder	nextToken(String nextToken)	The nextToken value returned from a previous paginated DescribeJobQueues request where maxResults was used and the results exceeded the value of that parameter.

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

copy

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

apply, build

Method Detail

jobQueues

DescribeJobQueuesRequest.Builder jobQueues(Collection<String> jobQueues)

A list of up to 100 queue names or full queue Amazon Resource Name (ARN) entries.

Parameters:

jobQueues - A list of up to 100 queue names or full queue Amazon Resource Name (ARN) entries.

Returns:

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

jobQueues

DescribeJobQueuesRequest.Builder jobQueues(String... jobQueues)

A list of up to 100 queue names or full queue Amazon Resource Name (ARN) entries.

NOTE: This method appends the values to the existing list (if any). Use #setJobQueues(java.util.Collection) or #withJobQueues(java.util.Collection) if you want to override the existing values.

Parameters:

jobQueues - A list of up to 100 queue names or full queue Amazon Resource Name (ARN) entries.

Returns:

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

maxResults

DescribeJobQueuesRequest.Builder maxResults(Integer maxResults)

The maximum number of results returned by DescribeJobQueues in paginated output. When this parameter is used, DescribeJobQueues 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 DescribeJobQueues request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then DescribeJobQueues returns up to 100 results and a nextToken value if applicable.

Parameters:

maxResults - The maximum number of results returned by DescribeJobQueues in paginated output. When this parameter is used, DescribeJobQueues 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 DescribeJobQueues request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then DescribeJobQueues 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

DescribeJobQueuesRequest.Builder nextToken(String nextToken)

The nextToken value returned from a previous paginated DescribeJobQueues 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 DescribeJobQueues 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.