Class SubmitJobRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<SubmitJobRequest.Builder,
SubmitJobRequest>
Contains the parameters for SubmitJob
.
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal ArrayProperties
The array properties for the submitted job, such as the size of the array.static SubmitJobRequest.Builder
builder()
final 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.final List
<JobDependency> A list of dependencies for the job.final 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.final 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.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final boolean
For responses, this returns true if the service returned a value for the DependsOn property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the Parameters property.final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final String
The job definition used by this job.final String
jobName()
The name of the job.final String
jobQueue()
The job queue where the job is submitted.final NodeOverrides
A list of node overrides in JSON format that specify the node range to target and the container overrides for that node range.Additional parameters passed to the job that replace parameter substitution placeholders that are set in the job definition.final Boolean
Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task.final RetryStrategy
The retry strategy to use for failed jobs from this SubmitJob operation.final Integer
The scheduling priority for the job.static Class
<? extends SubmitJobRequest.Builder> final String
The share identifier for the job.tags()
The tags that you apply to the job request to help you categorize and organize your resources.final JobTimeout
timeout()
The timeout configuration for this SubmitJob operation.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
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 (_).
- Returns:
- 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 (_).
-
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:
- The job queue where the job is submitted. You can specify either the name or the Amazon Resource Name (ARN) of the queue.
-
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:
- 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.
-
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:
- 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.
-
hasDependsOn
public final boolean hasDependsOn()For responses, this returns true if the service returned a value for the DependsOn property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
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.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasDependsOn()
method.- Returns:
- 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.
-
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.
- Returns:
- 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.
-
hasParameters
public final boolean hasParameters()For responses, this returns true if the service returned a value for the Parameters property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
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.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasParameters()
method.- Returns:
- 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.
-
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.- Returns:
- 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.
-
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:
- 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.
-
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:
- 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.
-
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.- Returns:
- 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.
-
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:
- 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.
-
hasTags
public final boolean hasTags()For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasTags()
method.- Returns:
- 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.
-
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:
- An object, with properties that override defaults for the job definition, can only be specified for jobs that are run on Amazon EKS resources.
-
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:
- An object, with properties that override defaults for the job definition, can only be specified for jobs that are run on Amazon ECS resources.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<SubmitJobRequest.Builder,
SubmitJobRequest> - Specified by:
toBuilder
in classBatchRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-