SubmitJobRequest (AWS SDK for Java

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

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 Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SubmitJobRequest`	`addParametersEntry(String key, String value)`
`SubmitJobRequest`	`clearParametersEntries()` Removes all the entries added into Parameters.
`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()` A list of container overrides in JSON format that specify the name of a container in the specified job definition and the overrides it should receive.
`List<JobDependency>`	`getDependsOn()` A list of dependencies for the job.
`String`	`getJobDefinition()` The job definition used by this job.
`String`	`getJobName()` The name of the job.
`String`	`getJobQueue()` The job queue into which 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.
`RetryStrategy`	`getRetryStrategy()` The retry strategy to use for failed jobs from this SubmitJob operation.
`JobTimeout`	`getTimeout()` The timeout configuration for this SubmitJob operation.
`int`	`hashCode()`
`void`	`setArrayProperties(ArrayProperties arrayProperties)` The array properties for the submitted job, such as the size of the array.
`void`	`setContainerOverrides(ContainerOverrides containerOverrides)` A list of container overrides in JSON format that specify the name of a container in the specified job definition and the overrides it should receive.
`void`	`setDependsOn(Collection<JobDependency> dependsOn)` A list of dependencies for the job.
`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 into which 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`	`setRetryStrategy(RetryStrategy retryStrategy)` The retry strategy to use for failed jobs from this SubmitJob operation.
`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)` A list of container overrides in JSON format that specify the name of a container in the specified job definition and the overrides it should receive.
`SubmitJobRequest`	`withDependsOn(Collection<JobDependency> dependsOn)` A list of dependencies for the job.
`SubmitJobRequest`	`withDependsOn(JobDependency... dependsOn)` A list of dependencies for the job.
`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 into which 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`	`withRetryStrategy(RetryStrategy retryStrategy)` The retry strategy to use for failed jobs from this SubmitJob operation.
`SubmitJobRequest`	`withTimeout(JobTimeout timeout)` The timeout configuration for this SubmitJob operation.

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. The first character must be alphanumeric, and up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.
    
    Parameters:
    
    jobName - The name of the job. The first character must be alphanumeric, and up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.
  - getJobName
```
public String getJobName()
```
    The name of the job. The first character must be alphanumeric, and up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.
    
    Returns:
    
    The name of the job. The first character must be alphanumeric, and up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.
  - withJobName
```
public SubmitJobRequest withJobName(String jobName)
```
    The name of the job. The first character must be alphanumeric, and up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.
    
    Parameters:
    
    jobName - The name of the job. The first character must be alphanumeric, and up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setJobQueue
```
public void setJobQueue(String jobQueue)
```
    The job queue into which the job is submitted. You can specify either the name or the Amazon Resource Name (ARN) of the queue.
    
    Parameters:
    
    jobQueue - The job queue into which the job is submitted. You can specify either the name or the Amazon Resource Name (ARN) of the queue.
  - getJobQueue
```
public String getJobQueue()
```
    The job queue into which the job is submitted. You can specify either the name or the Amazon Resource Name (ARN) of the queue.
    
    Returns:
    
    The job queue into which 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 into which the job is submitted. You can specify either the name or the Amazon Resource Name (ARN) of the queue.
    
    Parameters:
    
    jobQueue - The job queue into which the job is submitted. You can specify either the name or the Amazon Resource Name (ARN) of the queue.
    
    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 AWS 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 AWS 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 AWS 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 AWS 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 AWS 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 AWS 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 either a name:revision or the Amazon Resource Name (ARN) for the job definition.
    
    Parameters:
    
    jobDefinition - The job definition used by this job. This value can be either a name:revision or the Amazon Resource Name (ARN) for the job definition.
  - getJobDefinition
```
public String getJobDefinition()
```
    The job definition used by this job. This value can be either a name:revision or the Amazon Resource Name (ARN) for the job definition.
    
    Returns:
    
    The job definition used by this job. This value can be either a name:revision or the Amazon Resource Name (ARN) for the job definition.
  - withJobDefinition
```
public SubmitJobRequest withJobDefinition(String jobDefinition)
```
    The job definition used by this job. This value can be either a name:revision or the Amazon Resource Name (ARN) for the job definition.
    
    Parameters:
    
    jobDefinition - The job definition used by this job. This value can be either a name:revision or the Amazon Resource Name (ARN) for the job definition.
    
    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)
```
  - 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)
```
    A list of container overrides in JSON format that specify the name of a container in the specified job definition and the overrides it should receive. You can override the default command for a container (that is specified in the job definition or the Docker image) with a command override. You can also override existing environment variables (that are specified in the job definition or Docker image) on a container or add new environment variables to it with an environment override.
    
    Parameters:
    
    containerOverrides - A list of container overrides in JSON format that specify the name of a container in the specified job definition and the overrides it should receive. You can override the default command for a container (that is specified in the job definition or the Docker image) with a command override. You can also override existing environment variables (that are specified in the job definition or Docker image) on a container or add new environment variables to it with an environment override.
  - getContainerOverrides
```
public ContainerOverrides getContainerOverrides()
```
    A list of container overrides in JSON format that specify the name of a container in the specified job definition and the overrides it should receive. You can override the default command for a container (that is specified in the job definition or the Docker image) with a command override. You can also override existing environment variables (that are specified in the job definition or Docker image) on a container or add new environment variables to it with an environment override.
    
    Returns:
    
    A list of container overrides in JSON format that specify the name of a container in the specified job definition and the overrides it should receive. You can override the default command for a container (that is specified in the job definition or the Docker image) with a command override. You can also override existing environment variables (that are specified in the job definition or Docker image) on a container or add new environment variables to it with an environment override.
  - withContainerOverrides
```
public SubmitJobRequest withContainerOverrides(ContainerOverrides containerOverrides)
```
    A list of container overrides in JSON format that specify the name of a container in the specified job definition and the overrides it should receive. You can override the default command for a container (that is specified in the job definition or the Docker image) with a command override. You can also override existing environment variables (that are specified in the job definition or Docker image) on a container or add new environment variables to it with an environment override.
    
    Parameters:
    
    containerOverrides - A list of container overrides in JSON format that specify the name of a container in the specified job definition and the overrides it should receive. You can override the default command for a container (that is specified in the job definition or the Docker image) with a command override. You can also override existing environment variables (that are specified in the job definition or Docker image) on a container or add new environment variables to it with an environment override.
    
    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.
    
    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.
  - 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.
    
    Returns:
    
    A list of node overrides in JSON format that specify the node range to target and the container overrides for that node range.
  - 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.
    
    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.
    
    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.
  - setTimeout
```
public void setTimeout(JobTimeout timeout)
```
    The timeout configuration for this SubmitJob operation. You can specify a timeout duration after which AWS Batch terminates your jobs if they have not finished. If a job is terminated due to a timeout, it is not retried. The minimum value for the timeout is 60 seconds. This configuration overrides any timeout configuration specified in the job definition. For array jobs, child jobs have the same timeout configuration as the parent job. For more information, see Job Timeouts in the Amazon Elastic Container Service Developer Guide.
    
    Parameters:
    
    timeout - The timeout configuration for this SubmitJob operation. You can specify a timeout duration after which AWS Batch terminates your jobs if they have not finished. If a job is terminated due to a timeout, it is not retried. The minimum value for the timeout is 60 seconds. This configuration overrides any timeout configuration specified in the job definition. For array jobs, child jobs have the same timeout configuration as the parent job. For more information, see Job Timeouts in the Amazon Elastic Container Service Developer Guide.
  - getTimeout
```
public JobTimeout getTimeout()
```
    The timeout configuration for this SubmitJob operation. You can specify a timeout duration after which AWS Batch terminates your jobs if they have not finished. If a job is terminated due to a timeout, it is not retried. The minimum value for the timeout is 60 seconds. This configuration overrides any timeout configuration specified in the job definition. For array jobs, child jobs have the same timeout configuration as the parent job. For more information, see Job Timeouts in the Amazon Elastic Container Service Developer Guide.
    
    Returns:
    
    The timeout configuration for this SubmitJob operation. You can specify a timeout duration after which AWS Batch terminates your jobs if they have not finished. If a job is terminated due to a timeout, it is not retried. The minimum value for the timeout is 60 seconds. This configuration overrides any timeout configuration specified in the job definition. For array jobs, child jobs have the same timeout configuration as the parent job. For more information, see Job Timeouts in the Amazon Elastic Container Service Developer Guide.
  - withTimeout
```
public SubmitJobRequest withTimeout(JobTimeout timeout)
```
    The timeout configuration for this SubmitJob operation. You can specify a timeout duration after which AWS Batch terminates your jobs if they have not finished. If a job is terminated due to a timeout, it is not retried. The minimum value for the timeout is 60 seconds. This configuration overrides any timeout configuration specified in the job definition. For array jobs, child jobs have the same timeout configuration as the parent job. For more information, see Job Timeouts in the Amazon Elastic Container Service Developer Guide.
    
    Parameters:
    
    timeout - The timeout configuration for this SubmitJob operation. You can specify a timeout duration after which AWS Batch terminates your jobs if they have not finished. If a job is terminated due to a timeout, it is not retried. The minimum value for the timeout is 60 seconds. This configuration overrides any timeout configuration specified in the job definition. For array jobs, child jobs have the same timeout configuration as the parent job. For more information, see Job Timeouts in the Amazon Elastic Container Service Developer Guide.
    
    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()

Did this page help you?

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

setArrayProperties

getArrayProperties

withArrayProperties

getDependsOn

setDependsOn

withDependsOn

withDependsOn

setJobDefinition

getJobDefinition

withJobDefinition

getParameters

setParameters

withParameters

addParametersEntry

clearParametersEntries

setContainerOverrides

getContainerOverrides

withContainerOverrides

setNodeOverrides

getNodeOverrides

withNodeOverrides

setRetryStrategy

getRetryStrategy

withRetryStrategy

setTimeout

getTimeout

withTimeout

toString

equals

hashCode

clone