software.amazon.awssdk.services.batch.model

Interface RegisterJobDefinitionRequest.Builder

All Superinterfaces:

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

Enclosing class:

RegisterJobDefinitionRequest

public static interface RegisterJobDefinitionRequest.Builder
extends BatchRequest.Builder, SdkPojo, 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 to single-node container-based jobs.
RegisterJobDefinitionRequest.Builder	containerProperties(ContainerProperties containerProperties) An object with various properties specific to single-node container-based jobs.
RegisterJobDefinitionRequest.Builder	jobDefinitionName(String jobDefinitionName) The name of the job definition to register.
default RegisterJobDefinitionRequest.Builder	nodeProperties(Consumer<NodeProperties.Builder> nodeProperties) An object with various properties specific to multi-node parallel jobs.
RegisterJobDefinitionRequest.Builder	nodeProperties(NodeProperties nodeProperties) An object with various properties specific to multi-node parallel jobs.
RegisterJobDefinitionRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
RegisterJobDefinitionRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
RegisterJobDefinitionRequest.Builder	parameters(Map<String,String> parameters) Default parameter substitution placeholders to set in the job definition.
RegisterJobDefinitionRequest.Builder	platformCapabilities(Collection<PlatformCapability> platformCapabilities) The platform capabilities required by the job definition.
RegisterJobDefinitionRequest.Builder	platformCapabilities(PlatformCapability... platformCapabilities) The platform capabilities required by the job definition.
RegisterJobDefinitionRequest.Builder	platformCapabilitiesWithStrings(Collection<String> platformCapabilities) The platform capabilities required by the job definition.
RegisterJobDefinitionRequest.Builder	platformCapabilitiesWithStrings(String... platformCapabilities) The platform capabilities required by the job definition.
RegisterJobDefinitionRequest.Builder	propagateTags(Boolean propagateTags) Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task.
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	tags(Map<String,String> tags) The tags that you apply to the job definition to help you categorize and organize your resources.
default RegisterJobDefinitionRequest.Builder	timeout(Consumer<JobTimeout.Builder> timeout) The timeout configuration for jobs that are submitted with this job definition, after which AWS Batch terminates your jobs if they have not finished.
RegisterJobDefinitionRequest.Builder	timeout(JobTimeout timeout) The timeout configuration for jobs that are submitted with this job definition, after which AWS Batch terminates your jobs if they have not finished.
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

overrideConfiguration

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

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, 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. For more information about multi-node parallel jobs, see Creating a multi-node parallel job definition in the AWS Batch User Guide.

If the job is run on Fargate resources, then multinode isn't supported.

Parameters:

type - The type of job definition. For more information about multi-node parallel jobs, see Creating a multi-node parallel job definition in the AWS Batch User Guide.

If the job is run on Fargate resources, then multinode isn't supported.

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. For more information about multi-node parallel jobs, see Creating a multi-node parallel job definition in the AWS Batch User Guide.

If the job is run on Fargate resources, then multinode isn't supported.

Parameters:

type - The type of job definition. For more information about multi-node parallel jobs, see Creating a multi-node parallel job definition in the AWS Batch User Guide.

If the job is run on Fargate resources, then multinode isn't supported.

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 to single-node container-based jobs. If the job definition's type parameter is container, then you must specify either containerProperties or nodeProperties.

If the job runs on Fargate resources, then you must not specify nodeProperties; use only containerProperties.

Parameters:

containerProperties - An object with various properties specific to single-node container-based jobs. If the job definition's type parameter is container, then you must specify either containerProperties or nodeProperties.

If the job runs on Fargate resources, then you must not specify nodeProperties; use only containerProperties.

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 to single-node container-based jobs. If the job definition's type parameter is container, then you must specify either containerProperties or nodeProperties.

If the job runs on Fargate resources, then you must not specify nodeProperties; use only containerProperties.

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)

nodeProperties

RegisterJobDefinitionRequest.Builder nodeProperties(NodeProperties nodeProperties)

An object with various properties specific to multi-node parallel jobs. If you specify node properties for a job, it becomes a multi-node parallel job. For more information, see Multi-node Parallel Jobs in the AWS Batch User Guide. If the job definition's type parameter is container, then you must specify either containerProperties or nodeProperties.

If the job runs on Fargate resources, then you must not specify nodeProperties; use containerProperties instead.

Parameters:

nodeProperties - An object with various properties specific to multi-node parallel jobs. If you specify node properties for a job, it becomes a multi-node parallel job. For more information, see Multi-node Parallel Jobs in the AWS Batch User Guide. If the job definition's type parameter is container, then you must specify either containerProperties or nodeProperties.

If the job runs on Fargate resources, then you must not specify nodeProperties; use containerProperties instead.

Returns:

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

nodeProperties

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

An object with various properties specific to multi-node parallel jobs. If you specify node properties for a job, it becomes a multi-node parallel job. For more information, see Multi-node Parallel Jobs in the AWS Batch User Guide. If the job definition's type parameter is container, then you must specify either containerProperties or nodeProperties.

If the job runs on Fargate resources, then you must not specify nodeProperties; use containerProperties instead.

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

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's specified during a SubmitJob operation overrides the retry strategy defined here. If a job is terminated due to a timeout, it isn't retried.

Parameters:

retryStrategy - The retry strategy to use for failed jobs that are submitted with this job definition. Any retry strategy that's specified during a SubmitJob operation overrides the retry strategy defined here. If a job is terminated due to a timeout, it isn't retried.

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's specified during a SubmitJob operation overrides the retry strategy defined here. If a job is terminated due to a timeout, it isn't retried.

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)

propagateTags

RegisterJobDefinitionRequest.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 are not propagated. Tags can only be propagated to the tasks during task creation. 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 are not propagated. Tags can only be propagated to the tasks during task creation. 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.

timeout

RegisterJobDefinitionRequest.Builder timeout(JobTimeout timeout)

The timeout configuration for jobs that are submitted with this job definition, after which AWS Batch terminates your jobs if they have not finished. If a job is terminated due to a timeout, it isn't retried. The minimum value for the timeout is 60 seconds. Any timeout configuration that's specified during a SubmitJob operation overrides the timeout configuration defined here. For more information, see Job Timeouts in the AWS Batch User Guide.

Parameters:

timeout - The timeout configuration for jobs that are submitted with this job definition, after which AWS Batch terminates your jobs if they have not finished. If a job is terminated due to a timeout, it isn't retried. The minimum value for the timeout is 60 seconds. Any timeout configuration that's specified during a SubmitJob operation overrides the timeout configuration defined here. For more information, see Job Timeouts in the AWS Batch User Guide.

Returns:

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

timeout

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

The timeout configuration for jobs that are submitted with this job definition, after which AWS Batch terminates your jobs if they have not finished. If a job is terminated due to a timeout, it isn't retried. The minimum value for the timeout is 60 seconds. Any timeout configuration that's specified during a SubmitJob operation overrides the timeout configuration defined here. For more information, see Job Timeouts in the AWS Batch User Guide.

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

tags

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

The tags that you apply to the job definition to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging AWS Resources in AWS Batch User Guide.

Parameters:

tags - The tags that you apply to the job definition to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging AWS Resources in AWS Batch User Guide.

Returns:

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

platformCapabilitiesWithStrings

RegisterJobDefinitionRequest.Builder platformCapabilitiesWithStrings(Collection<String> platformCapabilities)

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

Parameters:

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

Returns:

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

platformCapabilitiesWithStrings

RegisterJobDefinitionRequest.Builder platformCapabilitiesWithStrings(String... platformCapabilities)

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

Parameters:

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

Returns:

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

platformCapabilities

RegisterJobDefinitionRequest.Builder platformCapabilities(Collection<PlatformCapability> platformCapabilities)

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

Parameters:

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

Returns:

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

platformCapabilities

RegisterJobDefinitionRequest.Builder platformCapabilities(PlatformCapability... platformCapabilities)

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

Parameters:

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

Returns:

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

overrideConfiguration

RegisterJobDefinitionRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

RegisterJobDefinitionRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder