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)
An object with various properties that override the defaults for the job definition that specify the name of
a container in the specified job definition and the overrides it should receive.
|
SubmitJobRequest.Builder |
containerOverrides(ContainerOverrides containerOverrides)
An object with various properties that override the defaults for the job definition 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.
|
default SubmitJobRequest.Builder |
eksPropertiesOverride(Consumer<EksPropertiesOverride.Builder> eksPropertiesOverride)
An object that can only be specified for jobs that are run on Amazon EKS resources with various properties
that override defaults for the job definition.
|
SubmitJobRequest.Builder |
eksPropertiesOverride(EksPropertiesOverride eksPropertiesOverride)
An object that can only be specified for jobs that are run on Amazon EKS resources with various properties
that override defaults for the job definition.
|
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 where 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) |
SubmitJobRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) |
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 |
propagateTags(Boolean propagateTags)
Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task.
|
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.
|
SubmitJobRequest.Builder |
schedulingPriorityOverride(Integer schedulingPriorityOverride)
The scheduling priority for the job.
|
SubmitJobRequest.Builder |
shareIdentifier(String shareIdentifier)
The share identifier for the job.
|
SubmitJobRequest.Builder |
tags(Map<String,String> tags)
The tags that you apply to the job request to help you categorize and organize your resources.
|
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.
|
buildoverrideConfigurationequalsBySdkFields, sdkFieldscopyapplyMutation, buildSubmitJobRequest.Builder jobName(String jobName)
The name of the job. It can be up to 128 letters long. The first character must be alphanumeric, can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).
jobName - The name of the job. It can be up to 128 letters long. The first character must be alphanumeric, can
contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).SubmitJobRequest.Builder jobQueue(String jobQueue)
The job queue where the job is submitted. You can specify either the name or the Amazon Resource Name (ARN) of the queue.
jobQueue - The job queue where the job is submitted. You can specify either the name or the Amazon Resource Name
(ARN) of the queue.SubmitJobRequest.Builder shareIdentifier(String shareIdentifier)
The share identifier for the job. Don't specify this parameter if the job queue doesn't have a scheduling policy. If the job queue has a scheduling policy, then this parameter must be specified.
This string is limited to 255 alphanumeric characters, and can be followed by an asterisk (*).
shareIdentifier - The share identifier for the job. Don't specify this parameter if the job queue doesn't have a
scheduling policy. If the job queue has a scheduling policy, then this parameter must be
specified.
This string is limited to 255 alphanumeric characters, and can be followed by an asterisk (*).
SubmitJobRequest.Builder schedulingPriorityOverride(Integer schedulingPriorityOverride)
The scheduling priority for the job. 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. This overrides any scheduling priority in the job definition.
The minimum supported value is 0 and the maximum supported value is 9999.
schedulingPriorityOverride - The scheduling priority for the job. 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.
This overrides any scheduling priority in the job definition.
The minimum supported value is 0 and the maximum supported value is 9999.
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 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 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 Batch User Guide.
This is a convenience method 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.
JobDependency.Builder avoiding the need to create one
manually via JobDependency.builder().
When the Consumer completes,
SdkBuilder.build() is called immediately and
its result is passed to #dependsOn(List.
dependsOn - a consumer that will call methods on
JobDependency.Builder#dependsOn(java.util.Collection) SubmitJobRequest.Builder jobDefinition(String jobDefinition)
The job definition used by this job. This value can be one of definition-name,
definition-name:revision, or the Amazon Resource Name (ARN) for the job definition, with or
without the revision (
arn:aws:batch:region:account:job-definition/definition-name:revision
, or arn:aws:batch:region:account:job-definition/definition-name ).
If the revision is not specified, then the latest active revision is used.
jobDefinition - The job definition used by this job. This value can be one of definition-name,
definition-name:revision, or the Amazon Resource Name (ARN) for the job definition, with
or without the revision (
arn:aws:batch:region:account:job-definition/definition-name:revision
, or arn:aws:batch:region:account:job-definition/definition-name
).
If the revision is not specified, then the latest active revision is used.
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)
An object with various properties that override the defaults for the job definition 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, which is specified in the job definition or the Docker image, with a
command override. You can also override existing environment variables on a container or add new
environment variables to it with an environment override.
containerOverrides - An object with various properties that override the defaults for the job definition 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, which is specified in the job definition or the Docker
image, with a command override. You can also override existing environment variables on a
container or add new environment variables to it with an environment override.default SubmitJobRequest.Builder containerOverrides(Consumer<ContainerOverrides.Builder> containerOverrides)
An object with various properties that override the defaults for the job definition 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, which is specified in the job definition or the Docker image, with a
command override. You can also override existing environment variables 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.
This parameter isn't applicable to jobs that are running on Fargate resources; use
containerOverrides instead.
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 parameter isn't applicable to jobs that are running on Fargate resources; use
containerOverrides instead.
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 parameter isn't applicable to jobs that are running on Fargate resources; use
containerOverrides instead.
NodeOverrides.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 method 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 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 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. When specified, this overrides the tag propagation setting in the job definition.
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
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. When specified, this overrides the tag propagation setting in
the job definition.SubmitJobRequest.Builder timeout(JobTimeout timeout)
The timeout configuration for this SubmitJob operation. You can specify a timeout duration after which Batch terminates your jobs if they haven't finished. If a job is terminated due to a timeout, it isn't 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 Batch terminates your jobs if they haven't finished. If a job is terminated due to a
timeout, it isn't 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 Batch terminates your jobs if they haven't finished. If a job is terminated due to a timeout, it isn't 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 method 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 tags(Map<String,String> tags)
The tags that you apply to the job request to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging Amazon Web Services Resources in Amazon Web Services General Reference.
tags - The tags that you apply to the job request to help you categorize and organize your resources. Each
tag consists of a key and an optional value. For more information, see Tagging Amazon Web Services
Resources in Amazon Web Services General Reference.SubmitJobRequest.Builder eksPropertiesOverride(EksPropertiesOverride eksPropertiesOverride)
An object that can only be specified for jobs that are run on Amazon EKS resources with various properties that override defaults for the job definition.
eksPropertiesOverride - An object that can only be specified for jobs that are run on Amazon EKS resources with various
properties that override defaults for the job definition.default SubmitJobRequest.Builder eksPropertiesOverride(Consumer<EksPropertiesOverride.Builder> eksPropertiesOverride)
An object that can only be specified for jobs that are run on Amazon EKS resources with various properties that override defaults for the job definition.
This is a convenience method that creates an instance of theEksPropertiesOverride.Builder avoiding
the need to create one manually via EksPropertiesOverride.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and
its result is passed to eksPropertiesOverride(EksPropertiesOverride).
eksPropertiesOverride - a consumer that will call methods on EksPropertiesOverride.BuildereksPropertiesOverride(EksPropertiesOverride)SubmitJobRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration in interface AwsRequest.BuilderSubmitJobRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration in interface AwsRequest.BuilderCopyright © 2023. All rights reserved.