software.amazon.awssdk.services.batch.model

Class SubmitJobRequest

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:

ToCopyableBuilder<SubmitJobRequest.Builder,SubmitJobRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SubmitJobRequest.Builder

Method Summary

Modifier and Type	Method and Description
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 job IDs on which this job depends.
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 will be submitted.
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.
static Class<? extends SubmitJobRequest.Builder>	serializableBuilderClass()
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

requestOverrideConfig

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 will be submitted. You can specify either the name or the Amazon Resource Name (ARN) of the queue.

Returns:

The job queue into which the job will be submitted. You can specify either the name or the Amazon Resource Name (ARN) of the queue.

dependsOn

public List<JobDependency> dependsOn()

A list of job IDs on which this job depends. A job can depend upon a maximum of 20 jobs.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

A list of job IDs on which this job depends. A job can depend upon a maximum of 20 jobs.

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.

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.

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