software.amazon.awssdk.services.batch.model

Interface RegisterJobDefinitionRequest.Builder

All Superinterfaces:

AwsRequest.Builder, BatchRequest.Builder, CopyableBuilder<RegisterJobDefinitionRequest.Builder,RegisterJobDefinitionRequest>, SdkBuilder<RegisterJobDefinitionRequest.Builder,RegisterJobDefinitionRequest>, SdkRequest.Builder

Enclosing class:

RegisterJobDefinitionRequest

public static interface RegisterJobDefinitionRequest.Builder
extends BatchRequest.Builder, CopyableBuilder<RegisterJobDefinitionRequest.Builder,RegisterJobDefinitionRequest>

Method Summary

Modifier and Type	Method and Description
default RegisterJobDefinitionRequest.Builder	containerProperties(Consumer<ContainerProperties.Builder> containerProperties) An object with various properties specific for container-based jobs.
RegisterJobDefinitionRequest.Builder	containerProperties(ContainerProperties containerProperties) An object with various properties specific for container-based jobs.
RegisterJobDefinitionRequest.Builder	jobDefinitionName(String jobDefinitionName) The name of the job definition to register.
RegisterJobDefinitionRequest.Builder	parameters(Map<String,String> parameters) Default parameter substitution placeholders to set in the job definition.
RegisterJobDefinitionRequest.Builder	requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig) Add an optional request override configuration.
RegisterJobDefinitionRequest.Builder	requestOverrideConfig(Consumer<AwsRequestOverrideConfig.Builder> builderConsumer) Add an optional request override configuration.
default RegisterJobDefinitionRequest.Builder	retryStrategy(Consumer<RetryStrategy.Builder> retryStrategy) The retry strategy to use for failed jobs that are submitted with this job definition.
RegisterJobDefinitionRequest.Builder	retryStrategy(RetryStrategy retryStrategy) The retry strategy to use for failed jobs that are submitted with this job definition.
RegisterJobDefinitionRequest.Builder	type(JobDefinitionType type) The type of job definition.
RegisterJobDefinitionRequest.Builder	type(String type) The type of job definition.

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

build

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

requestOverrideConfig

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

jobDefinitionName

RegisterJobDefinitionRequest.Builder jobDefinitionName(String jobDefinitionName)

The name of the job definition to register. Up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

Parameters:

jobDefinitionName - The name of the job definition to register. Up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

Returns:

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

type

RegisterJobDefinitionRequest.Builder type(String type)

The type of job definition.

Parameters:

type - The type of job definition.

Returns:

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

See Also:

JobDefinitionType, JobDefinitionType

type

RegisterJobDefinitionRequest.Builder type(JobDefinitionType type)

The type of job definition.

Parameters:

type - The type of job definition.

Returns:

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

See Also:

JobDefinitionType, JobDefinitionType

parameters

RegisterJobDefinitionRequest.Builder parameters(Map<String,String> parameters)

Default parameter substitution placeholders to set in the job definition. Parameters are specified as a key-value pair mapping. Parameters in a SubmitJob request override any corresponding parameter defaults from the job definition.

Parameters:

parameters - Default parameter substitution placeholders to set in the job definition. Parameters are specified as a key-value pair mapping. Parameters in a SubmitJob request override any corresponding parameter defaults from the job definition.

Returns:

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

containerProperties

RegisterJobDefinitionRequest.Builder containerProperties(ContainerProperties containerProperties)

An object with various properties specific for container-based jobs. This parameter is required if the type parameter is container.

Parameters:

containerProperties - An object with various properties specific for container-based jobs. This parameter is required if the type parameter is container.

Returns:

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

containerProperties

default RegisterJobDefinitionRequest.Builder containerProperties(Consumer<ContainerProperties.Builder> containerProperties)

An object with various properties specific for container-based jobs. This parameter is required if the type parameter is container.

This is a convenience that creates an instance of the ContainerProperties.Builder avoiding the need to create one manually via ContainerProperties.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to containerProperties(ContainerProperties).

Parameters:

containerProperties - a consumer that will call methods on ContainerProperties.Builder

Returns:

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

See Also:

containerProperties(ContainerProperties)

retryStrategy

RegisterJobDefinitionRequest.Builder retryStrategy(RetryStrategy retryStrategy)

The retry strategy to use for failed jobs that are submitted with this job definition. Any retry strategy that is specified during a SubmitJob operation overrides the retry strategy defined here.

Parameters:

retryStrategy - The retry strategy to use for failed jobs that are submitted with this job definition. Any retry strategy that is specified during a SubmitJob operation overrides the retry strategy defined here.

Returns:

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

retryStrategy

default RegisterJobDefinitionRequest.Builder retryStrategy(Consumer<RetryStrategy.Builder> retryStrategy)

The retry strategy to use for failed jobs that are submitted with this job definition. Any retry strategy that is specified during a SubmitJob operation overrides the retry strategy defined here.

This is a convenience that creates an instance of the RetryStrategy.Builder avoiding the need to create one manually via RetryStrategy.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to retryStrategy(RetryStrategy).

Parameters:

retryStrategy - a consumer that will call methods on RetryStrategy.Builder

Returns:

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

See Also:

retryStrategy(RetryStrategy)

requestOverrideConfig

RegisterJobDefinitionRequest.Builder requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

requestOverrideConfig in interface AwsRequest.Builder

Parameters:

awsRequestOverrideConfig - The override configuration.

Returns:

This object for method chaining.

requestOverrideConfig

RegisterJobDefinitionRequest.Builder requestOverrideConfig(Consumer<AwsRequestOverrideConfig.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

requestOverrideConfig in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfig.Builder will be given.

Returns:

This object for method chaining.