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

Interface DescribeJobDefinitionsRequest.Builder

All Superinterfaces:

CopyableBuilder<DescribeJobDefinitionsRequest.Builder,DescribeJobDefinitionsRequest>, SdkBuilder<DescribeJobDefinitionsRequest.Builder,DescribeJobDefinitionsRequest>

Enclosing class:

DescribeJobDefinitionsRequest

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

Method Summary

Modifier and Type	Method	Description
DescribeJobDefinitionsRequest.Builder	jobDefinitionName(String jobDefinitionName)	The name of the job definition to describe.
DescribeJobDefinitionsRequest.Builder	jobDefinitions(String... jobDefinitions)	A space-separated list of up to 100 job definition names or full Amazon Resource Name (ARN) entries.
DescribeJobDefinitionsRequest.Builder	jobDefinitions(Collection<String> jobDefinitions)	A space-separated list of up to 100 job definition names or full Amazon Resource Name (ARN) entries.
DescribeJobDefinitionsRequest.Builder	maxResults(Integer maxResults)	The maximum number of results returned by DescribeJobDefinitions in paginated output.
DescribeJobDefinitionsRequest.Builder	nextToken(String nextToken)	The nextToken value returned from a previous paginated DescribeJobDefinitions request where maxResults was used and the results exceeded the value of that parameter.
DescribeJobDefinitionsRequest.Builder	status(String status)	The status with which to filter job definitions.

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

jobDefinitions

DescribeJobDefinitionsRequest.Builder jobDefinitions(Collection<String> jobDefinitions)

A space-separated list of up to 100 job definition names or full Amazon Resource Name (ARN) entries.

Parameters:

jobDefinitions - A space-separated list of up to 100 job definition names or full Amazon Resource Name (ARN) entries.

Returns:

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

jobDefinitions

DescribeJobDefinitionsRequest.Builder jobDefinitions(String... jobDefinitions)

A space-separated list of up to 100 job definition names or full Amazon Resource Name (ARN) entries.

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

Parameters:

jobDefinitions - A space-separated list of up to 100 job definition names or full Amazon Resource Name (ARN) entries.

Returns:

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

maxResults

DescribeJobDefinitionsRequest.Builder maxResults(Integer maxResults)

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

Parameters:

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

jobDefinitionName

DescribeJobDefinitionsRequest.Builder jobDefinitionName(String jobDefinitionName)

The name of the job definition to describe.

Parameters:

jobDefinitionName - The name of the job definition to describe.

Returns:

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

status

DescribeJobDefinitionsRequest.Builder status(String status)

The status with which to filter job definitions.

Parameters:

status - The status with which to filter job definitions.

Returns:

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

nextToken

DescribeJobDefinitionsRequest.Builder nextToken(String nextToken)

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