Interface DescribeJobDefinitionsRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,BatchRequest.Builder
,Buildable
,CopyableBuilder<DescribeJobDefinitionsRequest.Builder,
,DescribeJobDefinitionsRequest> SdkBuilder<DescribeJobDefinitionsRequest.Builder,
,DescribeJobDefinitionsRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
DescribeJobDefinitionsRequest
-
Method Summary
Modifier and TypeMethodDescriptionjobDefinitionName
(String jobDefinitionName) The name of the job definition to describe.jobDefinitions
(String... jobDefinitions) A list of up to 100 job definitions.jobDefinitions
(Collection<String> jobDefinitions) A list of up to 100 job definitions.maxResults
(Integer maxResults) The maximum number of results returned byDescribeJobDefinitions
in paginated output.ThenextToken
value returned from a previous paginatedDescribeJobDefinitions
request wheremaxResults
was used and the results exceeded the value of that parameter.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.The status used to filter job definitions.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.services.batch.model.BatchRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
jobDefinitions
A list of up to 100 job definitions. Each entry in the list can either be an ARN in the format
arn:aws:batch:${Region}:${Account}:job-definition/${JobDefinitionName}:${Revision}
or a short version using the form${JobDefinitionName}:${Revision}
. This parameter can't be used with other parameters.- Parameters:
jobDefinitions
- A list of up to 100 job definitions. Each entry in the list can either be an ARN in the formatarn:aws:batch:${Region}:${Account}:job-definition/${JobDefinitionName}:${Revision}
or a short version using the form${JobDefinitionName}:${Revision}
. This parameter can't be used with other parameters.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
jobDefinitions
A list of up to 100 job definitions. Each entry in the list can either be an ARN in the format
arn:aws:batch:${Region}:${Account}:job-definition/${JobDefinitionName}:${Revision}
or a short version using the form${JobDefinitionName}:${Revision}
. This parameter can't be used with other parameters.- Parameters:
jobDefinitions
- A list of up to 100 job definitions. Each entry in the list can either be an ARN in the formatarn:aws:batch:${Region}:${Account}:job-definition/${JobDefinitionName}:${Revision}
or a short version using the form${JobDefinitionName}:${Revision}
. This parameter can't be used with other parameters.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
maxResults
The maximum number of results returned by
DescribeJobDefinitions
in paginated output. When this parameter is used,DescribeJobDefinitions
only returnsmaxResults
results in a single page and anextToken
response element. The remaining results of the initial request can be seen by sending anotherDescribeJobDefinitions
request with the returnednextToken
value. This value can be between 1 and 100. If this parameter isn't used, thenDescribeJobDefinitions
returns up to 100 results and anextToken
value if applicable.- Parameters:
maxResults
- The maximum number of results returned byDescribeJobDefinitions
in paginated output. When this parameter is used,DescribeJobDefinitions
only returnsmaxResults
results in a single page and anextToken
response element. The remaining results of the initial request can be seen by sending anotherDescribeJobDefinitions
request with the returnednextToken
value. This value can be between 1 and 100. If this parameter isn't used, thenDescribeJobDefinitions
returns up to 100 results and anextToken
value if applicable.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
The status used to filter job definitions.
- Parameters:
status
- The status used to filter job definitions.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
nextToken
The
nextToken
value returned from a previous paginatedDescribeJobDefinitions
request wheremaxResults
was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned thenextToken
value. This value isnull
when there are no more results to return.Treat this token as an opaque identifier that's only used to retrieve the next items in a list and not for other programmatic purposes.
- Parameters:
nextToken
- ThenextToken
value returned from a previous paginatedDescribeJobDefinitions
request wheremaxResults
was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned thenextToken
value. This value isnull
when there are no more results to return.Treat this token as an opaque identifier that's 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
DescribeJobDefinitionsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
DescribeJobDefinitionsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-