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

Interface SubmitJobRequest.Builder

All Superinterfaces:

CopyableBuilder<SubmitJobRequest.Builder,SubmitJobRequest>, SdkBuilder<SubmitJobRequest.Builder,SubmitJobRequest>

Enclosing class:

SubmitJobRequest

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

Method Summary

Modifier and Type	Method	Description
SubmitJobRequest.Builder	containerOverrides(ContainerOverrides containerOverrides)	A list of container overrides in JSON format that specify the name of a container in the specified job definition and the overrides it should receive.
SubmitJobRequest.Builder	dependsOn(Collection<JobDependency> dependsOn)	A list of job IDs on which this job depends.
SubmitJobRequest.Builder	dependsOn(JobDependency... dependsOn)	A list of job IDs on which this job depends.
SubmitJobRequest.Builder	jobDefinition(String jobDefinition)	The job definition used by this job.
SubmitJobRequest.Builder	jobName(String jobName)	The name of the job.
SubmitJobRequest.Builder	jobQueue(String jobQueue)	The job queue into which the job will be submitted.
SubmitJobRequest.Builder	parameters(Map<String,String> parameters)	Additional parameters passed to the job that replace parameter substitution placeholders that are set in the job definition.
SubmitJobRequest.Builder	retryStrategy(RetryStrategy retryStrategy)	The retry strategy to use for failed jobs from this SubmitJob operation.

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

jobName

SubmitJobRequest.Builder jobName(String jobName)

The name of the job. A name must be 1 to 128 characters in length.

Pattern: ^[a-zA-Z0-9_]+$

Parameters:

jobName - The name of the job. A name must be 1 to 128 characters in length.

Pattern: ^[a-zA-Z0-9_]+$

Returns:

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

jobQueue

SubmitJobRequest.Builder jobQueue(String jobQueue)

The job queue into which the job will be submitted. You can specify either the name or the Amazon Resource Name (ARN) of the queue.

Parameters:

jobQueue - The job queue into which the job will be submitted. You can specify either the name or the Amazon Resource Name (ARN) of the queue.

Returns:

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

dependsOn

SubmitJobRequest.Builder dependsOn(Collection<JobDependency> dependsOn)

A list of job IDs on which this job depends. A job can depend upon a maximum of 100 jobs.

Parameters:

dependsOn - A list of job IDs on which this job depends. A job can depend upon a maximum of 100 jobs.

Returns:

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

dependsOn

SubmitJobRequest.Builder dependsOn(JobDependency... dependsOn)

A list of job IDs on which this job depends. A job can depend upon a maximum of 100 jobs.

NOTE: This method appends the values to the existing list (if any). Use #setDependsOn(java.util.Collection) or #withDependsOn(java.util.Collection) if you want to override the existing values.

Parameters:

dependsOn - A list of job IDs on which this job depends. A job can depend upon a maximum of 100 jobs.

Returns:

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

jobDefinition

SubmitJobRequest.Builder jobDefinition(String jobDefinition)

The job definition used by this job. This value can be either a name:revision or the Amazon Resource Name (ARN) for the job definition.

Parameters:

jobDefinition - The job definition used by this job. This value can be either a name:revision or the Amazon Resource Name (ARN) for the job definition.

Returns:

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

parameters

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

Additional parameters passed to the job that replace parameter substitution placeholders that are set in the job definition. Parameters are specified as a key and value pair mapping. Parameters in a SubmitJob request override any corresponding parameter defaults from the job definition.

Parameters:

parameters - Additional parameters passed to the job that replace parameter substitution placeholders that are set in the job definition. Parameters are specified as a key and 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.

containerOverrides

SubmitJobRequest.Builder containerOverrides(ContainerOverrides containerOverrides)

A list of container overrides in JSON format that specify the name of a container in the specified job definition and the overrides it should receive. You can override the default command for a container (that is specified in the job definition or the Docker image) with a command override. You can also override existing environment variables (that are specified in the job definition or Docker image) on a container or add new environment variables to it with an environment override.

Parameters:

containerOverrides - A list of container overrides in JSON format that specify the name of a container in the specified job definition and the overrides it should receive. You can override the default command for a container (that is specified in the job definition or the Docker image) with a command override. You can also override existing environment variables (that are specified in the job definition or Docker image) on a container or add new environment variables to it with an environment override.

Returns:

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

retryStrategy

SubmitJobRequest.Builder retryStrategy(RetryStrategy retryStrategy)

The retry strategy to use for failed jobs from this SubmitJob operation. When a retry strategy is specified here, it overrides the retry strategy defined in the job definition.

Parameters:

retryStrategy - The retry strategy to use for failed jobs from this SubmitJob operation. When a retry strategy is specified here, it overrides the retry strategy defined in the job definition.

Returns:

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