SubmitJobRequest (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.batch.model.BatchRequest
    - - software.amazon.awssdk.services.batch.model.SubmitJobRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<SubmitJobRequest.Builder,SubmitJobRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class SubmitJobRequest
extends BatchRequest
implements ToCopyableBuilder<SubmitJobRequest.Builder,SubmitJobRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface SubmitJobRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`SubmitJobRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ArrayProperties`	`arrayProperties()` The array properties for the submitted job, such as the size of the array.
`static SubmitJobRequest.Builder`	`builder()`
`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.
`List<JobDependency>`	`dependsOn()` A list of dependencies for the job.
`boolean`	`equals(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)` Used to retrieve the value of a field from any class that extends `SdkRequest`.
`int`	`hashCode()`
`String`	`jobDefinition()` The job definition used by this job.
`String`	`jobName()` The name of the job.
`String`	`jobQueue()` The job queue into which the job is submitted.
`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.
`Map<String,String>`	`parameters()` Additional parameters passed to the job that replace parameter substitution placeholders that are set in the job definition.
`RetryStrategy`	`retryStrategy()` The retry strategy to use for failed jobs from this SubmitJob operation.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends SubmitJobRequest.Builder>`	`serializableBuilderClass()`
`JobTimeout`	`timeout()` The timeout configuration for this SubmitJob operation.
`SubmitJobRequest.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - jobName
```
public 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.
    
    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.
  - jobQueue
```
public 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.
    
    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.
  - arrayProperties
```
public 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.
    
    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.
  - dependsOn
```
public List<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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    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.
  - jobDefinition
```
public 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.
    
    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.
  - parameters
```
public 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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    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
```
public 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.
    
    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.
  - nodeOverrides
```
public 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.
    
    Returns:
    
    A list of node overrides in JSON format that specify the node range to target and the container overrides for that node range.
  - retryStrategy
```
public 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.
    
    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.
  - timeout
```
public 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.
    
    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.
  - toBuilder
```
public SubmitJobRequest.Builder 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 interface ToCopyableBuilder<SubmitJobRequest.Builder,SubmitJobRequest>
    
    Specified by:
    
    toBuilder in class BatchRequest
    
    Returns:
    
    a builder for type T
  - builder
```
public static SubmitJobRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends SubmitJobRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
    Description copied from class: SdkRequest
    
    Used to retrieve the value of a field from any class that extends SdkRequest. 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, the SdkRequest.getValueForField(String, Class) method will again be available.
    
    Overrides:
    
    getValueForField in class SdkRequest
    
    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
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

Class SubmitJobRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

jobName

jobQueue

arrayProperties

dependsOn

jobDefinition

parameters

containerOverrides

nodeOverrides

retryStrategy

timeout

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields