software.amazon.awssdk.services.batch.model

Interface JobDefinition.Builder

All Superinterfaces:

CopyableBuilder<JobDefinition.Builder,JobDefinition>, SdkBuilder<JobDefinition.Builder,JobDefinition>

Enclosing class:

JobDefinition

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

Method Summary

Modifier and Type	Method and Description
default JobDefinition.Builder	containerProperties(Consumer<ContainerProperties.Builder> containerProperties) An object with various properties specific to container-based jobs.
JobDefinition.Builder	containerProperties(ContainerProperties containerProperties) An object with various properties specific to container-based jobs.
JobDefinition.Builder	jobDefinitionArn(String jobDefinitionArn) The Amazon Resource Name (ARN) for the job definition.
JobDefinition.Builder	jobDefinitionName(String jobDefinitionName) The name of the job definition.
JobDefinition.Builder	parameters(Map<String,String> parameters) Default parameters or parameter substitution placeholders that are set in the job definition.
default JobDefinition.Builder	retryStrategy(Consumer<RetryStrategy.Builder> retryStrategy) The retry strategy to use for failed jobs that are submitted with this job definition.
JobDefinition.Builder	retryStrategy(RetryStrategy retryStrategy) The retry strategy to use for failed jobs that are submitted with this job definition.
JobDefinition.Builder	revision(Integer revision) The revision of the job definition.
JobDefinition.Builder	status(String status) The status of the job definition.
JobDefinition.Builder	type(String type) The type of job definition.

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

JobDefinition.Builder jobDefinitionName(String jobDefinitionName)

The name of the job definition.

Parameters:

jobDefinitionName - The name of the job definition.

Returns:

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

jobDefinitionArn

JobDefinition.Builder jobDefinitionArn(String jobDefinitionArn)

The Amazon Resource Name (ARN) for the job definition.

Parameters:

jobDefinitionArn - The Amazon Resource Name (ARN) for the job definition.

Returns:

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

revision

JobDefinition.Builder revision(Integer revision)

The revision of the job definition.

Parameters:

revision - The revision of the job definition.

Returns:

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

status

JobDefinition.Builder status(String status)

The status of the job definition.

Parameters:

status - The status of the job definition.

Returns:

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

type

JobDefinition.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.

parameters

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

Default parameters or parameter substitution placeholders that are 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 parameters or parameter substitution placeholders that are 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.

retryStrategy

JobDefinition.Builder retryStrategy(RetryStrategy retryStrategy)

The retry strategy to use for failed jobs that are submitted with this job definition.

Parameters:

retryStrategy - The retry strategy to use for failed jobs that are submitted with this job definition.

Returns:

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

retryStrategy

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

The retry strategy to use for failed jobs that are submitted with this job definition.

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)

containerProperties

JobDefinition.Builder containerProperties(ContainerProperties containerProperties)

An object with various properties specific to container-based jobs.

Parameters:

containerProperties - An object with various properties specific to container-based jobs.

Returns:

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

containerProperties

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

An object with various properties specific to container-based jobs.

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)