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

Interface JobDefinition.Builder

All Superinterfaces:

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

Enclosing class:

JobDefinition

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

Method Summary

Modifier and Type	Method	Description
JobDefinition.Builder	containerOrchestrationType(String containerOrchestrationType)	The orchestration type of the compute environment.
JobDefinition.Builder	containerOrchestrationType(OrchestrationType containerOrchestrationType)	The orchestration type of the compute environment.
default JobDefinition.Builder	containerProperties(Consumer<ContainerProperties.Builder> containerProperties)	An object with properties specific to Amazon ECS-based jobs.
JobDefinition.Builder	containerProperties(ContainerProperties containerProperties)	An object with properties specific to Amazon ECS-based jobs.
default JobDefinition.Builder	ecsProperties(Consumer<EcsProperties.Builder> ecsProperties)	An object that contains the properties for the Amazon ECS resources of a job.When ecsProperties is used in the job definition, it can't be used in addition to containerProperties, eksProperties, or nodeProperties.
JobDefinition.Builder	ecsProperties(EcsProperties ecsProperties)	An object that contains the properties for the Amazon ECS resources of a job.When ecsProperties is used in the job definition, it can't be used in addition to containerProperties, eksProperties, or nodeProperties.
default JobDefinition.Builder	eksProperties(Consumer<EksProperties.Builder> eksProperties)	An object with properties that are specific to Amazon EKS-based jobs.
JobDefinition.Builder	eksProperties(EksProperties eksProperties)	An object with properties that are specific to Amazon EKS-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.
default JobDefinition.Builder	nodeProperties(Consumer<NodeProperties.Builder> nodeProperties)	An object with properties that are specific to multi-node parallel jobs.
JobDefinition.Builder	nodeProperties(NodeProperties nodeProperties)	An object with properties that are specific to multi-node parallel jobs.
JobDefinition.Builder	parameters(Map<String,String> parameters)	Default parameters or parameter substitution placeholders that are set in the job definition.
JobDefinition.Builder	platformCapabilities(Collection<PlatformCapability> platformCapabilities)	The platform capabilities required by the job definition.
JobDefinition.Builder	platformCapabilities(PlatformCapability... platformCapabilities)	The platform capabilities required by the job definition.
JobDefinition.Builder	platformCapabilitiesWithStrings(String... platformCapabilities)	The platform capabilities required by the job definition.
JobDefinition.Builder	platformCapabilitiesWithStrings(Collection<String> platformCapabilities)	The platform capabilities required by the job definition.
JobDefinition.Builder	propagateTags(Boolean propagateTags)	Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task.
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	schedulingPriority(Integer schedulingPriority)	The scheduling priority of the job definition.
JobDefinition.Builder	status(String status)	The status of the job definition.
JobDefinition.Builder	tags(Map<String,String> tags)	The tags that are applied to the job definition.
default JobDefinition.Builder	timeout(Consumer<JobTimeout.Builder> timeout)	The timeout time for jobs that are submitted with this job definition.
JobDefinition.Builder	timeout(JobTimeout timeout)	The timeout time for jobs that are submitted with this 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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

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. It's either container or multinode. If the job is run on Fargate resources, then multinode isn't supported. For more information about multi-node parallel jobs, see Creating a multi-node parallel job definition in the Batch User Guide.

Parameters:

type - The type of job definition. It's either container or multinode. If the job is run on Fargate resources, then multinode isn't supported. For more information about multi-node parallel jobs, see Creating a multi-node parallel job definition in the Batch User Guide.

Returns:

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

schedulingPriority

JobDefinition.Builder schedulingPriority(Integer schedulingPriority)

The scheduling priority of the job definition. This only affects jobs in job queues with a fair share policy. Jobs with a higher scheduling priority are scheduled before jobs with a lower scheduling priority.

Parameters:

schedulingPriority - The scheduling priority of the job definition. This only affects jobs in job queues with a fair share policy. Jobs with a higher scheduling priority are scheduled before jobs with a lower scheduling priority.

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. For more information about specifying parameters, see Job definition parameters in the Batch User Guide.

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. For more information about specifying parameters, see Job definition parameters in the Batch User Guide.

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 method 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 properties specific to Amazon ECS-based jobs. When containerProperties is used in the job definition, it can't be used in addition to eksProperties, ecsProperties, or nodeProperties.

Parameters:

containerProperties - An object with properties specific to Amazon ECS-based jobs. When containerProperties is used in the job definition, it can't be used in addition to eksProperties, ecsProperties, or nodeProperties.

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 properties specific to Amazon ECS-based jobs. When containerProperties is used in the job definition, it can't be used in addition to eksProperties, ecsProperties, or nodeProperties.

This is a convenience method 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)

timeout

JobDefinition.Builder timeout(JobTimeout timeout)

The timeout time for jobs that are submitted with this job definition. After the amount of time you specify passes, Batch terminates your jobs if they aren't finished.

Parameters:

timeout - The timeout time for jobs that are submitted with this job definition. After the amount of time you specify passes, Batch terminates your jobs if they aren't finished.

Returns:

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

timeout

default JobDefinition.Builder timeout(Consumer<JobTimeout.Builder> timeout)

The timeout time for jobs that are submitted with this job definition. After the amount of time you specify passes, Batch terminates your jobs if they aren't finished.

This is a convenience method that creates an instance of the JobTimeout.Builder avoiding the need to create one manually via JobTimeout.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to timeout(JobTimeout).

Parameters:

timeout - a consumer that will call methods on JobTimeout.Builder

Returns:

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

See Also:

timeout(JobTimeout)

nodeProperties

JobDefinition.Builder nodeProperties(NodeProperties nodeProperties)

An object with properties that are specific to multi-node parallel jobs. When nodeProperties is used in the job definition, it can't be used in addition to containerProperties, ecsProperties, or eksProperties.

If the job runs on Fargate resources, don't specify nodeProperties. Use containerProperties instead.

Parameters:

nodeProperties - An object with properties that are specific to multi-node parallel jobs. When nodeProperties is used in the job definition, it can't be used in addition to containerProperties, ecsProperties, or eksProperties.

If the job runs on Fargate resources, don't specify nodeProperties. Use containerProperties instead.

Returns:

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

nodeProperties

default JobDefinition.Builder nodeProperties(Consumer<NodeProperties.Builder> nodeProperties)

An object with properties that are specific to multi-node parallel jobs. When nodeProperties is used in the job definition, it can't be used in addition to containerProperties, ecsProperties, or eksProperties.

If the job runs on Fargate resources, don't specify nodeProperties. Use containerProperties instead.

This is a convenience method that creates an instance of the NodeProperties.Builder avoiding the need to create one manually via NodeProperties.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to nodeProperties(NodeProperties).

Parameters:

nodeProperties - a consumer that will call methods on NodeProperties.Builder

Returns:

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

See Also:

nodeProperties(NodeProperties)

tags

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

The tags that are applied to the job definition.

Parameters:

tags - The tags that are applied to the job definition.

Returns:

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

propagateTags

JobDefinition.Builder propagateTags(Boolean propagateTags)

Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task. If no value is specified, the tags aren't propagated. Tags can only be propagated to the tasks when the tasks are created. For tags with the same name, job tags are given priority over job definitions tags. If the total number of combined tags from the job and job definition is over 50, the job is moved to the FAILED state.

Parameters:

propagateTags - Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task. If no value is specified, the tags aren't propagated. Tags can only be propagated to the tasks when the tasks are created. For tags with the same name, job tags are given priority over job definitions tags. If the total number of combined tags from the job and job definition is over 50, the job is moved to the FAILED state.

Returns:

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

platformCapabilitiesWithStrings

JobDefinition.Builder platformCapabilitiesWithStrings(Collection<String> platformCapabilities)

The platform capabilities required by the job definition. If no value is specified, it defaults to EC2. Jobs run on Fargate resources specify FARGATE.

Parameters:

platformCapabilities - The platform capabilities required by the job definition. If no value is specified, it defaults to EC2. Jobs run on Fargate resources specify FARGATE.

Returns:

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

platformCapabilitiesWithStrings

JobDefinition.Builder platformCapabilitiesWithStrings(String... platformCapabilities)

The platform capabilities required by the job definition. If no value is specified, it defaults to EC2. Jobs run on Fargate resources specify FARGATE.

Parameters:

platformCapabilities - The platform capabilities required by the job definition. If no value is specified, it defaults to EC2. Jobs run on Fargate resources specify FARGATE.

Returns:

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

platformCapabilities

JobDefinition.Builder platformCapabilities(Collection<PlatformCapability> platformCapabilities)

The platform capabilities required by the job definition. If no value is specified, it defaults to EC2. Jobs run on Fargate resources specify FARGATE.

Parameters:

platformCapabilities - The platform capabilities required by the job definition. If no value is specified, it defaults to EC2. Jobs run on Fargate resources specify FARGATE.

Returns:

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

platformCapabilities

JobDefinition.Builder platformCapabilities(PlatformCapability... platformCapabilities)

The platform capabilities required by the job definition. If no value is specified, it defaults to EC2. Jobs run on Fargate resources specify FARGATE.

Parameters:

platformCapabilities - The platform capabilities required by the job definition. If no value is specified, it defaults to EC2. Jobs run on Fargate resources specify FARGATE.

Returns:

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

ecsProperties

JobDefinition.Builder ecsProperties(EcsProperties ecsProperties)

An object that contains the properties for the Amazon ECS resources of a job.When ecsProperties is used in the job definition, it can't be used in addition to containerProperties, eksProperties, or nodeProperties.

Parameters:

ecsProperties - An object that contains the properties for the Amazon ECS resources of a job.When ecsProperties is used in the job definition, it can't be used in addition to containerProperties, eksProperties, or nodeProperties.

Returns:

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

ecsProperties

default JobDefinition.Builder ecsProperties(Consumer<EcsProperties.Builder> ecsProperties)

An object that contains the properties for the Amazon ECS resources of a job.When ecsProperties is used in the job definition, it can't be used in addition to containerProperties, eksProperties, or nodeProperties.

This is a convenience method that creates an instance of the EcsProperties.Builder avoiding the need to create one manually via EcsProperties.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to ecsProperties(EcsProperties).

Parameters:

ecsProperties - a consumer that will call methods on EcsProperties.Builder

Returns:

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

See Also:

ecsProperties(EcsProperties)

eksProperties

JobDefinition.Builder eksProperties(EksProperties eksProperties)

An object with properties that are specific to Amazon EKS-based jobs. When eksProperties is used in the job definition, it can't be used in addition to containerProperties, ecsProperties, or nodeProperties.

Parameters:

eksProperties - An object with properties that are specific to Amazon EKS-based jobs. When eksProperties is used in the job definition, it can't be used in addition to containerProperties, ecsProperties, or nodeProperties.

Returns:

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

eksProperties

default JobDefinition.Builder eksProperties(Consumer<EksProperties.Builder> eksProperties)

An object with properties that are specific to Amazon EKS-based jobs. When eksProperties is used in the job definition, it can't be used in addition to containerProperties, ecsProperties, or nodeProperties.

This is a convenience method that creates an instance of the EksProperties.Builder avoiding the need to create one manually via EksProperties.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to eksProperties(EksProperties).

Parameters:

eksProperties - a consumer that will call methods on EksProperties.Builder

Returns:

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

See Also:

eksProperties(EksProperties)

containerOrchestrationType

JobDefinition.Builder containerOrchestrationType(String containerOrchestrationType)

The orchestration type of the compute environment. The valid values are ECS (default) or EKS.

Parameters:

containerOrchestrationType - The orchestration type of the compute environment. The valid values are ECS (default) or EKS.

Returns:

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

See Also:

OrchestrationType, OrchestrationType

containerOrchestrationType

JobDefinition.Builder containerOrchestrationType(OrchestrationType containerOrchestrationType)

The orchestration type of the compute environment. The valid values are ECS (default) or EKS.

Parameters:

containerOrchestrationType - The orchestration type of the compute environment. The valid values are ECS (default) or EKS.

Returns:

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

See Also:

OrchestrationType, OrchestrationType