com.amazonaws.services.batch.model

Class RegisterJobDefinitionRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.batch.model.RegisterJobDefinitionRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class RegisterJobDefinitionRequest
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
RegisterJobDefinitionRequest()

Method Summary

Modifier and Type	Method and Description
RegisterJobDefinitionRequest	addParametersEntry(String key, String value) Add a single Parameters entry
RegisterJobDefinitionRequest	addTagsEntry(String key, String value) Add a single Tags entry
RegisterJobDefinitionRequest	clearParametersEntries() Removes all the entries added into Parameters.
RegisterJobDefinitionRequest	clearTagsEntries() Removes all the entries added into Tags.
RegisterJobDefinitionRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
ContainerProperties	getContainerProperties() An object with various properties specific to single-node container-based jobs.
String	getJobDefinitionName() The name of the job definition to register.
NodeProperties	getNodeProperties() An object with various properties specific to multi-node parallel jobs.
Map<String,String>	getParameters() Default parameter substitution placeholders to set in the job definition.
RetryStrategy	getRetryStrategy() The retry strategy to use for failed jobs that are submitted with this job definition.
Map<String,String>	getTags() The tags that you apply to the job definition to help you categorize and organize your resources.
JobTimeout	getTimeout() The timeout configuration for jobs that are submitted with this job definition, after which AWS Batch terminates your jobs if they have not finished.
String	getType() The type of job definition.
int	hashCode()
void	setContainerProperties(ContainerProperties containerProperties) An object with various properties specific to single-node container-based jobs.
void	setJobDefinitionName(String jobDefinitionName) The name of the job definition to register.
void	setNodeProperties(NodeProperties nodeProperties) An object with various properties specific to multi-node parallel jobs.
void	setParameters(Map<String,String> parameters) Default parameter substitution placeholders to set in the job definition.
void	setRetryStrategy(RetryStrategy retryStrategy) The retry strategy to use for failed jobs that are submitted with this job definition.
void	setTags(Map<String,String> tags) The tags that you apply to the job definition to help you categorize and organize your resources.
void	setTimeout(JobTimeout timeout) The timeout configuration for jobs that are submitted with this job definition, after which AWS Batch terminates your jobs if they have not finished.
void	setType(JobDefinitionType type) The type of job definition.
void	setType(String type) The type of job definition.
String	toString() Returns a string representation of this object.
RegisterJobDefinitionRequest	withContainerProperties(ContainerProperties containerProperties) An object with various properties specific to single-node container-based jobs.
RegisterJobDefinitionRequest	withJobDefinitionName(String jobDefinitionName) The name of the job definition to register.
RegisterJobDefinitionRequest	withNodeProperties(NodeProperties nodeProperties) An object with various properties specific to multi-node parallel jobs.
RegisterJobDefinitionRequest	withParameters(Map<String,String> parameters) Default parameter substitution placeholders to set in the job definition.
RegisterJobDefinitionRequest	withRetryStrategy(RetryStrategy retryStrategy) The retry strategy to use for failed jobs that are submitted with this job definition.
RegisterJobDefinitionRequest	withTags(Map<String,String> tags) The tags that you apply to the job definition to help you categorize and organize your resources.
RegisterJobDefinitionRequest	withTimeout(JobTimeout timeout) The timeout configuration for jobs that are submitted with this job definition, after which AWS Batch terminates your jobs if they have not finished.
RegisterJobDefinitionRequest	withType(JobDefinitionType type) The type of job definition.
RegisterJobDefinitionRequest	withType(String type) The type of job definition.

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

RegisterJobDefinitionRequest

public RegisterJobDefinitionRequest()

Method Detail

setJobDefinitionName

public void setJobDefinitionName(String jobDefinitionName)

The name of the job definition to register. Up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

Parameters:

jobDefinitionName - The name of the job definition to register. Up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

getJobDefinitionName

public String getJobDefinitionName()

The name of the job definition to register. Up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

Returns:

The name of the job definition to register. Up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

withJobDefinitionName

public RegisterJobDefinitionRequest withJobDefinitionName(String jobDefinitionName)

The name of the job definition to register. Up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

Parameters:

jobDefinitionName - The name of the job definition to register. 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.

setType

public void setType(String type)

The type of job definition.

Parameters:

type - The type of job definition.

See Also:

JobDefinitionType

getType

public String getType()

The type of job definition.

Returns:

The type of job definition.

See Also:

JobDefinitionType

withType

public RegisterJobDefinitionRequest withType(String type)

The type of job definition.

Parameters:

type - The type of job definition.

Returns:

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

See Also:

JobDefinitionType

setType

public void setType(JobDefinitionType type)

The type of job definition.

Parameters:

type - The type of job definition.

See Also:

JobDefinitionType

withType

public RegisterJobDefinitionRequest withType(JobDefinitionType type)

The type of job definition.

Parameters:

type - The type of job definition.

Returns:

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

See Also:

JobDefinitionType

getParameters

public Map<String,String> getParameters()

Default parameter substitution placeholders to set in the job definition. Parameters are specified as a key-value pair mapping. Parameters in a SubmitJob request override any corresponding parameter defaults from the job definition.

Returns:

Default parameter substitution placeholders to set in the job definition. Parameters are specified as a key-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)

Default parameter substitution placeholders to set in the job definition. Parameters are specified as a key-value pair mapping. Parameters in a SubmitJob request override any corresponding parameter defaults from the job definition.

Parameters:

parameters - Default parameter substitution placeholders to set in the job definition. Parameters are specified as a key-value pair mapping. Parameters in a SubmitJob request override any corresponding parameter defaults from the job definition.

withParameters

public RegisterJobDefinitionRequest withParameters(Map<String,String> parameters)

Default parameter substitution placeholders to set in the job definition. Parameters are specified as a key-value pair mapping. Parameters in a SubmitJob request override any corresponding parameter defaults from the job definition.

Parameters:

parameters - Default parameter substitution placeholders to set in the job definition. Parameters are specified as a key-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 RegisterJobDefinitionRequest addParametersEntry(String key,
                                                       String value)

Add a single Parameters entry

See Also:

withParameters(java.util.Map<java.lang.String, java.lang.String>)

clearParametersEntries

public RegisterJobDefinitionRequest clearParametersEntries()

Removes all the entries added into Parameters.

Returns:

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

setContainerProperties

public void setContainerProperties(ContainerProperties containerProperties)

An object with various properties specific to single-node container-based jobs. If the job definition's type parameter is container, then you must specify either containerProperties or nodeProperties.

Parameters:

containerProperties - An object with various properties specific to single-node container-based jobs. If the job definition's type parameter is container, then you must specify either containerProperties or nodeProperties.

getContainerProperties

public ContainerProperties getContainerProperties()

An object with various properties specific to single-node container-based jobs. If the job definition's type parameter is container, then you must specify either containerProperties or nodeProperties.

Returns:

An object with various properties specific to single-node container-based jobs. If the job definition's type parameter is container, then you must specify either containerProperties or nodeProperties.

withContainerProperties

public RegisterJobDefinitionRequest withContainerProperties(ContainerProperties containerProperties)

An object with various properties specific to single-node container-based jobs. If the job definition's type parameter is container, then you must specify either containerProperties or nodeProperties.

Parameters:

containerProperties - An object with various properties specific to single-node container-based jobs. If the job definition's type parameter is container, then you must specify either containerProperties or nodeProperties.

Returns:

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

setNodeProperties

public void setNodeProperties(NodeProperties nodeProperties)

An object with various properties specific to multi-node parallel jobs. If you specify node properties for a job, it becomes a multi-node parallel job. For more information, see Multi-node Parallel Jobs in the AWS Batch User Guide. If the job definition's type parameter is container, then you must specify either containerProperties or nodeProperties.

Parameters:

nodeProperties - An object with various properties specific to multi-node parallel jobs. If you specify node properties for a job, it becomes a multi-node parallel job. For more information, see Multi-node Parallel Jobs in the AWS Batch User Guide. If the job definition's type parameter is container, then you must specify either containerProperties or nodeProperties.

getNodeProperties

public NodeProperties getNodeProperties()

An object with various properties specific to multi-node parallel jobs. If you specify node properties for a job, it becomes a multi-node parallel job. For more information, see Multi-node Parallel Jobs in the AWS Batch User Guide. If the job definition's type parameter is container, then you must specify either containerProperties or nodeProperties.

Returns:

An object with various properties specific to multi-node parallel jobs. If you specify node properties for a job, it becomes a multi-node parallel job. For more information, see Multi-node Parallel Jobs in the AWS Batch User Guide. If the job definition's type parameter is container, then you must specify either containerProperties or nodeProperties.

withNodeProperties

public RegisterJobDefinitionRequest withNodeProperties(NodeProperties nodeProperties)

An object with various properties specific to multi-node parallel jobs. If you specify node properties for a job, it becomes a multi-node parallel job. For more information, see Multi-node Parallel Jobs in the AWS Batch User Guide. If the job definition's type parameter is container, then you must specify either containerProperties or nodeProperties.

Parameters:

nodeProperties - An object with various properties specific to multi-node parallel jobs. If you specify node properties for a job, it becomes a multi-node parallel job. For more information, see Multi-node Parallel Jobs in the AWS Batch User Guide. If the job definition's type parameter is container, then you must specify either containerProperties or nodeProperties.

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 that are submitted with this job definition. Any retry strategy that is specified during a SubmitJob operation overrides the retry strategy defined here. If a job is terminated due to a timeout, it is not retried.

Parameters:

retryStrategy - The retry strategy to use for failed jobs that are submitted with this job definition. Any retry strategy that is specified during a SubmitJob operation overrides the retry strategy defined here. If a job is terminated due to a timeout, it is not retried.

getRetryStrategy

public RetryStrategy getRetryStrategy()

The retry strategy to use for failed jobs that are submitted with this job definition. Any retry strategy that is specified during a SubmitJob operation overrides the retry strategy defined here. If a job is terminated due to a timeout, it is not retried.

Returns:

The retry strategy to use for failed jobs that are submitted with this job definition. Any retry strategy that is specified during a SubmitJob operation overrides the retry strategy defined here. If a job is terminated due to a timeout, it is not retried.

withRetryStrategy

public RegisterJobDefinitionRequest withRetryStrategy(RetryStrategy retryStrategy)

The retry strategy to use for failed jobs that are submitted with this job definition. Any retry strategy that is specified during a SubmitJob operation overrides the retry strategy defined here. If a job is terminated due to a timeout, it is not retried.

Parameters:

retryStrategy - The retry strategy to use for failed jobs that are submitted with this job definition. Any retry strategy that is specified during a SubmitJob operation overrides the retry strategy defined here. If a job is terminated due to a timeout, it is not retried.

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 jobs that are submitted with this job definition, 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. Any timeout configuration that is specified during a SubmitJob operation overrides the timeout configuration defined here. For more information, see Job Timeouts in the Amazon Elastic Container Service Developer Guide.

Parameters:

timeout - The timeout configuration for jobs that are submitted with this job definition, 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. Any timeout configuration that is specified during a SubmitJob operation overrides the timeout configuration defined here. For more information, see Job Timeouts in the Amazon Elastic Container Service Developer Guide.

getTimeout

public JobTimeout getTimeout()

The timeout configuration for jobs that are submitted with this job definition, 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. Any timeout configuration that is specified during a SubmitJob operation overrides the timeout configuration defined here. For more information, see Job Timeouts in the Amazon Elastic Container Service Developer Guide.

Returns:

The timeout configuration for jobs that are submitted with this job definition, 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. Any timeout configuration that is specified during a SubmitJob operation overrides the timeout configuration defined here. For more information, see Job Timeouts in the Amazon Elastic Container Service Developer Guide.

withTimeout

public RegisterJobDefinitionRequest withTimeout(JobTimeout timeout)

The timeout configuration for jobs that are submitted with this job definition, 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. Any timeout configuration that is specified during a SubmitJob operation overrides the timeout configuration defined here. For more information, see Job Timeouts in the Amazon Elastic Container Service Developer Guide.

Parameters:

timeout - The timeout configuration for jobs that are submitted with this job definition, 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. Any timeout configuration that is specified during a SubmitJob operation overrides the timeout configuration defined here. 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 definition to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging AWS Resources in AWS General Reference.

Returns:

The tags that you apply to the job definition to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging AWS Resources in AWS General Reference.

setTags

public void setTags(Map<String,String> tags)

The tags that you apply to the job definition to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging AWS Resources in AWS General Reference.

Parameters:

tags - The tags that you apply to the job definition to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging AWS Resources in AWS General Reference.

withTags

public RegisterJobDefinitionRequest withTags(Map<String,String> tags)

The tags that you apply to the job definition to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging AWS Resources in AWS General Reference.

Parameters:

tags - The tags that you apply to the job definition to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging AWS Resources in AWS General Reference.

Returns:

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

addTagsEntry

public RegisterJobDefinitionRequest addTagsEntry(String key,
                                                 String value)

Add a single Tags entry

See Also:

withTags(java.util.Map<java.lang.String, java.lang.String>)

clearTagsEntries

public RegisterJobDefinitionRequest clearTagsEntries()

Removes all the entries added into Tags.

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