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

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
SubmitJobRequest()

Method Summary

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)
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 job IDs on which this job depends.
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 will be submitted.
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.
int	hashCode()
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 job IDs on which this job depends.
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 will be submitted.
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.
String	toString() Returns a string representation of this object; useful for testing and debugging.
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 job IDs on which this job depends.
SubmitJobRequest	withDependsOn(JobDependency... dependsOn) A list of job IDs on which this job depends.
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 will be submitted.
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.

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. 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 will be 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 will be 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 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.

withJobQueue

public SubmitJobRequest withJobQueue(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

getDependsOn

public List<JobDependency> getDependsOn()

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

Returns:

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

setDependsOn

public void setDependsOn(Collection<JobDependency> dependsOn)

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

Parameters:

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

withDependsOn

public SubmitJobRequest withDependsOn(JobDependency... dependsOn)

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

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 job IDs on which this job depends. A job can depend upon a maximum of 20 jobs.

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 job IDs on which this job depends. A job can depend upon a maximum of 20 jobs.

Parameters:

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

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.

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.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

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()