public static interface SubmitJobRequest.Builder extends BatchRequest.Builder, SdkPojo, CopyableBuilder<SubmitJobRequest.Builder,SubmitJobRequest>
| Modifier and Type | Method and Description |
|---|---|
SubmitJobRequest.Builder |
arrayProperties(ArrayProperties arrayProperties)
The array properties for the submitted job, such as the size of the array.
|
default SubmitJobRequest.Builder |
arrayProperties(Consumer<ArrayProperties.Builder> arrayProperties)
The array properties for the submitted job, such as the size of the array.
|
default SubmitJobRequest.Builder |
containerOverrides(Consumer<ContainerOverrides.Builder> 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 |
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 dependencies for the job.
|
SubmitJobRequest.Builder |
dependsOn(Consumer<JobDependency.Builder>... dependsOn)
A list of dependencies for the job.
|
SubmitJobRequest.Builder |
dependsOn(JobDependency... dependsOn)
A list of dependencies for the job.
|
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 is submitted.
|
default SubmitJobRequest.Builder |
nodeOverrides(Consumer<NodeOverrides.Builder> nodeOverrides)
A list of node overrides in JSON format that specify the node range to target and the container overrides for
that node range.
|
SubmitJobRequest.Builder |
nodeOverrides(NodeOverrides nodeOverrides)
A list of node overrides in JSON format that specify the node range to target and the container overrides for
that node range.
|
SubmitJobRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
Add an optional request override configuration.
|
SubmitJobRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
Add an optional request override configuration.
|
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.
|
default SubmitJobRequest.Builder |
retryStrategy(Consumer<RetryStrategy.Builder> retryStrategy)
The retry strategy to use for failed jobs from this SubmitJob operation.
|
SubmitJobRequest.Builder |
retryStrategy(RetryStrategy retryStrategy)
The retry strategy to use for failed jobs from this SubmitJob operation.
|
default SubmitJobRequest.Builder |
timeout(Consumer<JobTimeout.Builder> timeout)
The timeout configuration for this SubmitJob operation.
|
SubmitJobRequest.Builder |
timeout(JobTimeout timeout)
The timeout configuration for this SubmitJob operation.
|
buildoverrideConfigurationcopyapplyMutation, buildSubmitJobRequest.Builder jobName(String jobName)
The name of the job. The first character must be alphanumeric, and up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.
jobName - The name of the job. The first character must be alphanumeric, and up to 128 letters (uppercase and
lowercase), numbers, hyphens, and underscores are allowed.SubmitJobRequest.Builder jobQueue(String jobQueue)
The job queue into which the job is submitted. You can specify either the name or the Amazon Resource Name (ARN) of the queue.
jobQueue - The job queue into which the job is submitted. You can specify either the name or the Amazon Resource
Name (ARN) of the queue.SubmitJobRequest.Builder arrayProperties(ArrayProperties arrayProperties)
The array properties for the submitted job, such as the size of the array. The array size can be between 2 and 10,000. If you specify array properties for a job, it becomes an array job. For more information, see Array Jobs in the AWS Batch User Guide.
arrayProperties - The array properties for the submitted job, such as the size of the array. The array size can be
between 2 and 10,000. If you specify array properties for a job, it becomes an array job. For more
information, see Array
Jobs in the AWS Batch User Guide.default SubmitJobRequest.Builder arrayProperties(Consumer<ArrayProperties.Builder> arrayProperties)
The array properties for the submitted job, such as the size of the array. The array size can be between 2 and 10,000. If you specify array properties for a job, it becomes an array job. For more information, see Array Jobs in the AWS Batch User Guide.
This is a convenience that creates an instance of theArrayProperties.Builder avoiding the need to
create one manually via ArrayProperties.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its
result is passed to arrayProperties(ArrayProperties).arrayProperties - a consumer that will call methods on ArrayProperties.BuilderarrayProperties(ArrayProperties)SubmitJobRequest.Builder dependsOn(Collection<JobDependency> dependsOn)
A list of dependencies for the job. A job can depend upon a maximum of 20 jobs. You can specify a
SEQUENTIAL type dependency without specifying a job ID for array jobs so that each child array
job completes sequentially, starting at index 0. You can also specify an N_TO_N type dependency
with a job ID for array jobs. In that case, each index child of this job must wait for the corresponding
index child of each dependency to complete before it can begin.
dependsOn - A list of dependencies for the job. A job can depend upon a maximum of 20 jobs. You can specify a
SEQUENTIAL type dependency without specifying a job ID for array jobs so that each child
array job completes sequentially, starting at index 0. You can also specify an N_TO_N
type dependency with a job ID for array jobs. In that case, each index child of this job must wait for
the corresponding index child of each dependency to complete before it can begin.SubmitJobRequest.Builder dependsOn(JobDependency... dependsOn)
A list of dependencies for the job. A job can depend upon a maximum of 20 jobs. You can specify a
SEQUENTIAL type dependency without specifying a job ID for array jobs so that each child array
job completes sequentially, starting at index 0. You can also specify an N_TO_N type dependency
with a job ID for array jobs. In that case, each index child of this job must wait for the corresponding
index child of each dependency to complete before it can begin.
dependsOn - A list of dependencies for the job. A job can depend upon a maximum of 20 jobs. You can specify a
SEQUENTIAL type dependency without specifying a job ID for array jobs so that each child
array job completes sequentially, starting at index 0. You can also specify an N_TO_N
type dependency with a job ID for array jobs. In that case, each index child of this job must wait for
the corresponding index child of each dependency to complete before it can begin.SubmitJobRequest.Builder dependsOn(Consumer<JobDependency.Builder>... dependsOn)
A list of dependencies for the job. A job can depend upon a maximum of 20 jobs. You can specify a
SEQUENTIAL type dependency without specifying a job ID for array jobs so that each child array
job completes sequentially, starting at index 0. You can also specify an N_TO_N type dependency
with a job ID for array jobs. In that case, each index child of this job must wait for the corresponding
index child of each dependency to complete before it can begin.
List.Builder avoiding the need
to create one manually via List#builder() .
When the Consumer completes, List.Builder#build() is called immediately and
its result is passed to #dependsOn(List) .dependsOn - a consumer that will call methods on List.Builder #dependsOn(List) 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.
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.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 - 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.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.
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.default SubmitJobRequest.Builder containerOverrides(Consumer<ContainerOverrides.Builder> 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.
ContainerOverrides.Builder avoiding the need to
create one manually via ContainerOverrides.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its
result is passed to containerOverrides(ContainerOverrides).containerOverrides - a consumer that will call methods on ContainerOverrides.BuildercontainerOverrides(ContainerOverrides)SubmitJobRequest.Builder nodeOverrides(NodeOverrides nodeOverrides)
A list of node overrides in JSON format that specify the node range to target and the container overrides for that node range.
nodeOverrides - A list of node overrides in JSON format that specify the node range to target and the container
overrides for that node range.default SubmitJobRequest.Builder nodeOverrides(Consumer<NodeOverrides.Builder> nodeOverrides)
A list of node overrides in JSON format that specify the node range to target and the container overrides for that node range.
This is a convenience that creates an instance of theNodeOverrides.Builder avoiding the need to
create one manually via NodeOverrides.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its
result is passed to nodeOverrides(NodeOverrides).nodeOverrides - a consumer that will call methods on NodeOverrides.BuildernodeOverrides(NodeOverrides)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.
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.default SubmitJobRequest.Builder retryStrategy(Consumer<RetryStrategy.Builder> 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.
This is a convenience that creates an instance of theRetryStrategy.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).retryStrategy - a consumer that will call methods on RetryStrategy.BuilderretryStrategy(RetryStrategy)SubmitJobRequest.Builder timeout(JobTimeout timeout)
The timeout configuration for this SubmitJob operation. You can specify a timeout duration after which AWS Batch terminates your jobs if they have not finished. If a job is terminated due to a timeout, it is not retried. The minimum value for the timeout is 60 seconds. This configuration overrides any timeout configuration specified in the job definition. For array jobs, child jobs have the same timeout configuration as the parent job. For more information, see Job Timeouts in the Amazon Elastic Container Service Developer Guide.
timeout - The timeout configuration for this SubmitJob operation. You can specify a timeout duration
after which AWS Batch terminates your jobs if they have not finished. If a job is terminated due to a
timeout, it is not retried. The minimum value for the timeout is 60 seconds. This configuration
overrides any timeout configuration specified in the job definition. For array jobs, child jobs have
the same timeout configuration as the parent job. For more information, see Job Timeouts
in the Amazon Elastic Container Service Developer Guide.default SubmitJobRequest.Builder timeout(Consumer<JobTimeout.Builder> timeout)
The timeout configuration for this SubmitJob operation. You can specify a timeout duration after which AWS Batch terminates your jobs if they have not finished. If a job is terminated due to a timeout, it is not retried. The minimum value for the timeout is 60 seconds. This configuration overrides any timeout configuration specified in the job definition. For array jobs, child jobs have the same timeout configuration as the parent job. For more information, see Job Timeouts in the Amazon Elastic Container Service Developer Guide.
This is a convenience that creates an instance of theJobTimeout.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).timeout - a consumer that will call methods on JobTimeout.Buildertimeout(JobTimeout)SubmitJobRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
AwsRequest.BuilderoverrideConfiguration in interface AwsRequest.BuilderoverrideConfiguration - The override configuration.SubmitJobRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
AwsRequest.BuilderoverrideConfiguration in interface AwsRequest.BuilderbuilderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be
given.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.