Interface SubmitJobRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,BatchRequest.Builder
,Buildable
,CopyableBuilder<SubmitJobRequest.Builder,
,SubmitJobRequest> SdkBuilder<SubmitJobRequest.Builder,
,SubmitJobRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
SubmitJobRequest
-
Method Summary
Modifier and TypeMethodDescriptiondefault SubmitJobRequest.Builder
arrayProperties
(Consumer<ArrayProperties.Builder> arrayProperties) The array properties for the submitted job, such as the size of the array.arrayProperties
(ArrayProperties 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 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.containerOverrides
(ContainerOverrides containerOverrides) An object with 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.dependsOn
(Collection<JobDependency> dependsOn) A list of dependencies for the job.dependsOn
(Consumer<JobDependency.Builder>... dependsOn) A list of dependencies for the job.dependsOn
(JobDependency... dependsOn) A list of dependencies for the job.default SubmitJobRequest.Builder
ecsPropertiesOverride
(Consumer<EcsPropertiesOverride.Builder> ecsPropertiesOverride) An object, with properties that override defaults for the job definition, can only be specified for jobs that are run on Amazon ECS resources.ecsPropertiesOverride
(EcsPropertiesOverride ecsPropertiesOverride) An object, with properties that override defaults for the job definition, can only be specified for jobs that are run on Amazon ECS resources.default SubmitJobRequest.Builder
eksPropertiesOverride
(Consumer<EksPropertiesOverride.Builder> eksPropertiesOverride) An object, with properties that override defaults for the job definition, can only be specified for jobs that are run on Amazon EKS resources.eksPropertiesOverride
(EksPropertiesOverride eksPropertiesOverride) An object, with properties that override defaults for the job definition, can only be specified for jobs that are run on Amazon EKS resources.jobDefinition
(String jobDefinition) The job definition used by this job.The name of the job.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.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.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.parameters
(Map<String, String> parameters) Additional parameters passed to the job that replace parameter substitution placeholders that are set in the job definition.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.retryStrategy
(RetryStrategy retryStrategy) The retry strategy to use for failed jobs from this SubmitJob operation.schedulingPriorityOverride
(Integer schedulingPriorityOverride) The scheduling priority for the job.shareIdentifier
(String shareIdentifier) The share identifier for the job.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.timeout
(JobTimeout timeout) The timeout configuration for this SubmitJob operation.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.services.batch.model.BatchRequest.Builder
build
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, sdkFields
-
Method Details
-
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 (_).
- Parameters:
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 (_).- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
jobQueue
The job queue where the job is submitted. You can specify either the name or the Amazon Resource Name (ARN) of the queue.
- Parameters:
jobQueue
- The job queue where the job is 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.
-
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 and works only within a single share identifier.
The minimum supported value is 0 and the maximum supported value is 9999.
- Parameters:
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 and works only within a single share identifier.The minimum supported value is 0 and the maximum supported value is 9999.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 viaArrayProperties.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toarrayProperties(ArrayProperties)
.- Parameters:
arrayProperties
- a consumer that will call methods onArrayProperties.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 anN_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.- Parameters:
dependsOn
- A list of dependencies for the job. A job can depend upon a maximum of 20 jobs. You can specify aSEQUENTIAL
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 anN_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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 anN_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.- Parameters:
dependsOn
- A list of dependencies for the job. A job can depend upon a maximum of 20 jobs. You can specify aSEQUENTIAL
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 anN_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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
dependsOn
A list of dependencies for the job. A job can depend upon a maximum of 20 jobs. You can specify a
This is a convenience method that creates an instance of theSEQUENTIAL
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 anN_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 viaJobDependency.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed todependsOn(List<JobDependency>)
.- Parameters:
dependsOn
- a consumer that will call methods onJobDependency.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
, orarn:aws:batch:region:account:job-definition/definition-name
).If the revision is not specified, then the latest active revision is used.
- Parameters:
jobDefinition
- The job definition used by this job. This value can be one ofdefinition-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
, orarn:aws:batch:region:account:job-definition/definition-name
).If the revision is not specified, then the latest active revision is used.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 aSubmitJob
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
An object with 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 anenvironment
override.- Parameters:
containerOverrides
- An object with 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 acommand
override. You can also override existing environment variables on a container or add new environment variables to it with anenvironment
override.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
containerOverrides
default SubmitJobRequest.Builder containerOverrides(Consumer<ContainerOverrides.Builder> containerOverrides) An object with 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
This is a convenience method that creates an instance of thecommand
override. You can also override existing environment variables on a container or add new environment variables to it with anenvironment
override.ContainerOverrides.Builder
avoiding the need to create one manually viaContainerOverrides.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tocontainerOverrides(ContainerOverrides)
.- Parameters:
containerOverrides
- a consumer that will call methods onContainerOverrides.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 viaNodeOverrides.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tonodeOverrides(NodeOverrides)
.- Parameters:
nodeOverrides
- a consumer that will call methods onNodeOverrides.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
-
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 viaRetryStrategy.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toretryStrategy(RetryStrategy)
.- Parameters:
retryStrategy
- a consumer that will call methods onRetryStrategy.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.- 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 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 theFAILED
state. When specified, this overrides the tag propagation setting in the job definition.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 viaJobTimeout.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totimeout(JobTimeout)
.- Parameters:
timeout
- a consumer that will call methods onJobTimeout.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
eksPropertiesOverride
An object, with properties that override defaults for the job definition, can only be specified for jobs that are run on Amazon EKS resources.
- Parameters:
eksPropertiesOverride
- An object, with properties that override defaults for the job definition, can only be specified for jobs that are run on Amazon EKS resources.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
eksPropertiesOverride
default SubmitJobRequest.Builder eksPropertiesOverride(Consumer<EksPropertiesOverride.Builder> eksPropertiesOverride) An object, with properties that override defaults for the job definition, can only be specified for jobs that are run on Amazon EKS resources.
This is a convenience method that creates an instance of theEksPropertiesOverride.Builder
avoiding the need to create one manually viaEksPropertiesOverride.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toeksPropertiesOverride(EksPropertiesOverride)
.- Parameters:
eksPropertiesOverride
- a consumer that will call methods onEksPropertiesOverride.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
ecsPropertiesOverride
An object, with properties that override defaults for the job definition, can only be specified for jobs that are run on Amazon ECS resources.
- Parameters:
ecsPropertiesOverride
- An object, with properties that override defaults for the job definition, can only be specified for jobs that are run on Amazon ECS resources.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
ecsPropertiesOverride
default SubmitJobRequest.Builder ecsPropertiesOverride(Consumer<EcsPropertiesOverride.Builder> ecsPropertiesOverride) An object, with properties that override defaults for the job definition, can only be specified for jobs that are run on Amazon ECS resources.
This is a convenience method that creates an instance of theEcsPropertiesOverride.Builder
avoiding the need to create one manually viaEcsPropertiesOverride.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toecsPropertiesOverride(EcsPropertiesOverride)
.- Parameters:
ecsPropertiesOverride
- a consumer that will call methods onEcsPropertiesOverride.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
overrideConfiguration
SubmitJobRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
SubmitJobRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-