SubmitJobRequest (AWS SDK for Java

JavaScript is disabled on your browser.

AWS SDK for Java 1.x API Reference - 1.12.795

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

com.amazonaws.services.batch.model

Class SubmitJobRequest

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.batch.model.SubmitJobRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class SubmitJobRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable 
```
Contains the parameters for SubmitJob.

See Also:

AWS API Documentation, Serialized Form

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceRequest
  NOOP

Constructor Summary

Constructors
Constructor and Description

SubmitJobRequest ()

Constructors
Constructor and Description
`SubmitJobRequest ()`

Method Summary

All Methods
Modifier and Type	Method and Description
`SubmitJobRequest`	`addParametersEntry (String key, String value)` Add a single Parameters entry
`SubmitJobRequest`	`addTagsEntry (String key, String value)` Add a single Tags entry
`SubmitJobRequest`	`clearParametersEntries ()` Removes all the entries added into Parameters.
`SubmitJobRequest`	`clearTagsEntries ()` Removes all the entries added into Tags.
`SubmitJobRequest`	`clone ()` Creates a shallow clone of this object for all fields except the handler context.
`boolean`	`equals (Object obj)`
`ArrayProperties`	`getArrayProperties ()` The array properties for the submitted job, such as the size of the array.
`ContainerOverrides`	`getContainerOverrides ()` 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.
`List<JobDependency>`	`getDependsOn ()` A list of dependencies for the job.
`EcsPropertiesOverride`	`getEcsPropertiesOverride ()` An object, with properties that override defaults for the job definition, can only be specified for jobs that are run on Amazon ECS resources.
`EksPropertiesOverride`	`getEksPropertiesOverride ()` An object, with properties that override defaults for the job definition, can only be specified for jobs that are run on Amazon EKS resources.
`String`	`getJobDefinition ()` The job definition used by this job.
`String`	`getJobName ()` The name of the job.
`String`	`getJobQueue ()` The job queue where the job is submitted.
`NodeOverrides`	`getNodeOverrides ()` A list of node overrides in JSON format that specify the node range to target and the container overrides for that node range.
`Map<String,String>`	`getParameters ()` Additional parameters passed to the job that replace parameter substitution placeholders that are set in the job definition.
`Boolean`	`getPropagateTags ()` Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task.
`RetryStrategy`	`getRetryStrategy ()` The retry strategy to use for failed jobs from this SubmitJob operation.
`Integer`	`getSchedulingPriorityOverride ()` The scheduling priority for the job.
`String`	`getShareIdentifier ()` The share identifier for the job.
`Map<String,String>`	`getTags ()` The tags that you apply to the job request to help you categorize and organize your resources.
`JobTimeout`	`getTimeout ()` The timeout configuration for this SubmitJob operation.
`int`	`hashCode ()`
`Boolean`	`isPropagateTags ()` Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task.
`void`	`setArrayProperties (ArrayProperties arrayProperties)` The array properties for the submitted job, such as the size of the array.
`void`	`setContainerOverrides (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.
`void`	`setDependsOn (Collection<JobDependency> dependsOn)` A list of dependencies for the job.
`void`	`setEcsPropertiesOverride (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.
`void`	`setEksPropertiesOverride (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.
`void`	`setJobDefinition (String jobDefinition)` The job definition used by this job.
`void`	`setJobName (String jobName)` The name of the job.
`void`	`setJobQueue (String jobQueue)` The job queue where the job is submitted.
`void`	`setNodeOverrides (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.
`void`	`setParameters (Map<String,String> parameters)` Additional parameters passed to the job that replace parameter substitution placeholders that are set in the job definition.
`void`	`setPropagateTags (Boolean propagateTags)` Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task.
`void`	`setRetryStrategy (RetryStrategy retryStrategy)` The retry strategy to use for failed jobs from this SubmitJob operation.
`void`	`setSchedulingPriorityOverride (Integer schedulingPriorityOverride)` The scheduling priority for the job.
`void`	`setShareIdentifier (String shareIdentifier)` The share identifier for the job.
`void`	`setTags (Map<String,String> tags)` The tags that you apply to the job request to help you categorize and organize your resources.
`void`	`setTimeout (JobTimeout timeout)` The timeout configuration for this SubmitJob operation.
`String`	`toString ()` Returns a string representation of this object.
`SubmitJobRequest`	`withArrayProperties (ArrayProperties arrayProperties)` The array properties for the submitted job, such as the size of the array.
`SubmitJobRequest`	`withContainerOverrides (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.
`SubmitJobRequest`	`withDependsOn (Collection<JobDependency> dependsOn)` A list of dependencies for the job.
`SubmitJobRequest`	`withDependsOn (JobDependency... dependsOn)` A list of dependencies for the job.
`SubmitJobRequest`	`withEcsPropertiesOverride (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.
`SubmitJobRequest`	`withEksPropertiesOverride (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.
`SubmitJobRequest`	`withJobDefinition (String jobDefinition)` The job definition used by this job.
`SubmitJobRequest`	`withJobName (String jobName)` The name of the job.
`SubmitJobRequest`	`withJobQueue (String jobQueue)` The job queue where the job is submitted.
`SubmitJobRequest`	`withNodeOverrides (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`	`withParameters (Map<String,String> parameters)` Additional parameters passed to the job that replace parameter substitution placeholders that are set in the job definition.
`SubmitJobRequest`	`withPropagateTags (Boolean propagateTags)` Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task.
`SubmitJobRequest`	`withRetryStrategy (RetryStrategy retryStrategy)` The retry strategy to use for failed jobs from this SubmitJob operation.
`SubmitJobRequest`	`withSchedulingPriorityOverride (Integer schedulingPriorityOverride)` The scheduling priority for the job.
`SubmitJobRequest`	`withShareIdentifier (String shareIdentifier)` The share identifier for the job.
`SubmitJobRequest`	`withTags (Map<String,String> tags)` The tags that you apply to the job request to help you categorize and organize your resources.
`SubmitJobRequest`	`withTimeout (JobTimeout timeout)` The timeout configuration for this SubmitJob operation.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - SubmitJobRequest
```
public SubmitJobRequest()
```
- Method Detail
  - setJobName
```
public void setJobName(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 (_).
    
    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 (_).
  - getJobName
```
public String getJobName()
```
    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 (_).
  - withJobName
```
public SubmitJobRequest withJobName(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 (_).
    
    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.
  - setJobQueue
```
public void setJobQueue(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.
    
    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.
  - getJobQueue
```
public String getJobQueue()
```
    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.
  - withJobQueue
```
public SubmitJobRequest withJobQueue(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.
    
    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.
  - setShareIdentifier
```
public void setShareIdentifier(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 (*).
    
    Parameters:
    
    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 (*).
  - getShareIdentifier
```
public String getShareIdentifier()
```
    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 (*).
    
    Returns:
    
    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 (*).
  - withShareIdentifier
```
public SubmitJobRequest withShareIdentifier(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 (*).
    
    Parameters:
    
    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 (*).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSchedulingPriorityOverride
```
public void setSchedulingPriorityOverride(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 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.
  - getSchedulingPriorityOverride
```
public Integer getSchedulingPriorityOverride()
```
    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.
  - withSchedulingPriorityOverride
```
public SubmitJobRequest withSchedulingPriorityOverride(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 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.
  - setArrayProperties
```
public void setArrayProperties(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.
    
    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.
  - getArrayProperties
```
public ArrayProperties getArrayProperties()
```
    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.
  - withArrayProperties
```
public SubmitJobRequest withArrayProperties(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.
    
    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.
  - getDependsOn
```
public List<JobDependency> getDependsOn()
```
    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.
    
    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 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.
  - setDependsOn
```
public void setDependsOn(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.
    
    Parameters:
    
    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.
  - withDependsOn
```
public SubmitJobRequest withDependsOn(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.
    
    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 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withDependsOn
```
public SubmitJobRequest withDependsOn(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setJobDefinition
```
public void setJobDefinition(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.
    
    Parameters:
    
    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.
  - getJobDefinition
```
public String getJobDefinition()
```
    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.
    
    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 , or arn:aws:batch:region:account:job-definition/definition-name ).
    
    If the revision is not specified, then the latest active revision is used.
  - withJobDefinition
```
public SubmitJobRequest withJobDefinition(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getParameters
```
public Map<String,String> getParameters()
```
    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:
    
    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.
  - setParameters
```
public void setParameters(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.
  - withParameters
```
public SubmitJobRequest withParameters(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.
  - addParametersEntry
```
public SubmitJobRequest addParametersEntry(String key,
 String value)
```
    Add a single Parameters entry
    
    See Also:
    
    withParameters(java.util.Map<java.lang.String, java.lang.String>)
  - clearParametersEntries
```
public SubmitJobRequest clearParametersEntries()
```
    Removes all the entries added into Parameters.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setContainerOverrides
```
public void setContainerOverrides(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. 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.
    
    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 a command override. You can also override existing environment variables on a container or add new environment variables to it with an environment override.
  - getContainerOverrides
```
public ContainerOverrides getContainerOverrides()
```
    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 an environment 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 an environment override.
  - withContainerOverrides
```
public SubmitJobRequest withContainerOverrides(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. 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.
    
    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 a command override. You can also override existing environment variables 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.
  - setNodeOverrides
```
public void setNodeOverrides(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.
    
    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.
  - getNodeOverrides
```
public NodeOverrides getNodeOverrides()
```
    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.
  - withNodeOverrides
```
public SubmitJobRequest withNodeOverrides(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.
    
    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.
  - setRetryStrategy
```
public void setRetryStrategy(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.
  - getRetryStrategy
```
public RetryStrategy getRetryStrategy()
```
    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.
  - withRetryStrategy
```
public SubmitJobRequest withRetryStrategy(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.
  - setPropagateTags
```
public void setPropagateTags(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.
    
    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 the FAILED state. When specified, this overrides the tag propagation setting in the job definition.
  - getPropagateTags
```
public Boolean getPropagateTags()
```
    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.
  - withPropagateTags
```
public SubmitJobRequest withPropagateTags(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.
    
    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 the FAILED 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.
  - isPropagateTags
```
public Boolean isPropagateTags()
```
    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.
  - setTimeout
```
public void setTimeout(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.
    
    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.
  - getTimeout
```
public JobTimeout getTimeout()
```
    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.
  - withTimeout
```
public SubmitJobRequest withTimeout(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.
    
    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.
  - getTags
```
public Map<String,String> getTags()
```
    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:
    
    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.
  - setTags
```
public void setTags(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.
    
    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.
  - withTags
```
public SubmitJobRequest withTags(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.
    
    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.
  - addTagsEntry
```
public SubmitJobRequest addTagsEntry(String key,
 String value)
```
    Add a single Tags entry
    
    See Also:
    
    withTags(java.util.Map<java.lang.String, java.lang.String>)
  - clearTagsEntries
```
public SubmitJobRequest clearTagsEntries()
```
    Removes all the entries added into Tags.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEksPropertiesOverride
```
public void setEksPropertiesOverride(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.
    
    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.
  - getEksPropertiesOverride
```
public EksPropertiesOverride getEksPropertiesOverride()
```
    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.
  - withEksPropertiesOverride
```
public SubmitJobRequest withEksPropertiesOverride(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.
    
    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.
  - setEcsPropertiesOverride
```
public void setEcsPropertiesOverride(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.
    
    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.
  - getEcsPropertiesOverride
```
public EcsPropertiesOverride getEcsPropertiesOverride()
```
    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.
  - withEcsPropertiesOverride
```
public SubmitJobRequest withEcsPropertiesOverride(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.
    
    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.
  - toString
```
public String 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.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public SubmitJobRequest clone()
```
    Description copied from class: AmazonWebServiceRequest
    
    Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.
    
    Overrides:
    
    clone in class AmazonWebServiceRequest
    
    See Also:
    
    Object.clone()

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

AWS SDK for Java 1.x API Reference - 1.12.795

Class SubmitJobRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

SubmitJobRequest

Method Detail

setJobName

getJobName

withJobName

setJobQueue

getJobQueue

withJobQueue

setShareIdentifier

getShareIdentifier

withShareIdentifier

setSchedulingPriorityOverride

getSchedulingPriorityOverride

withSchedulingPriorityOverride

setArrayProperties

getArrayProperties

withArrayProperties

getDependsOn

setDependsOn

withDependsOn

withDependsOn

setJobDefinition

getJobDefinition

withJobDefinition

getParameters

setParameters

withParameters

addParametersEntry

clearParametersEntries

setContainerOverrides

getContainerOverrides

withContainerOverrides

setNodeOverrides

getNodeOverrides

withNodeOverrides

setRetryStrategy

getRetryStrategy

withRetryStrategy

setPropagateTags

getPropagateTags

withPropagateTags

isPropagateTags

setTimeout

getTimeout

withTimeout

getTags

setTags

withTags

addTagsEntry

clearTagsEntries

setEksPropertiesOverride

getEksPropertiesOverride

withEksPropertiesOverride

setEcsPropertiesOverride

getEcsPropertiesOverride

withEcsPropertiesOverride

toString

equals

hashCode

clone