JobDefinition (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.batch.model.JobDefinition

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class JobDefinition
extends Object
implements Serializable, Cloneable, StructuredPojo
```
An object representing an Batch job definition.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

JobDefinition()

Constructors
Constructor and Description
`JobDefinition()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`JobDefinition`	`addParametersEntry(String key, String value)` Add a single Parameters entry
`JobDefinition`	`addTagsEntry(String key, String value)` Add a single Tags entry
`JobDefinition`	`clearParametersEntries()` Removes all the entries added into Parameters.
`JobDefinition`	`clearTagsEntries()` Removes all the entries added into Tags.
`JobDefinition`	`clone()`
`boolean`	`equals(Object obj)`
`ContainerProperties`	`getContainerProperties()` An object with various properties specific to container-based jobs.
`String`	`getJobDefinitionArn()` The Amazon Resource Name (ARN) for the job definition.
`String`	`getJobDefinitionName()` The name of the job definition.
`NodeProperties`	`getNodeProperties()` An object with various properties specific to multi-node parallel jobs.
`Map<String,String>`	`getParameters()` Default parameters or parameter substitution placeholders that are set in the job definition.
`List<String>`	`getPlatformCapabilities()` The platform capabilities required by the job definition.
`Boolean`	`getPropagateTags()` Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task.
`RetryStrategy`	`getRetryStrategy()` The retry strategy to use for failed jobs that are submitted with this job definition.
`Integer`	`getRevision()` The revision of the job definition.
`String`	`getStatus()` The status of the job definition.
`Map<String,String>`	`getTags()` The tags applied to the job definition.
`JobTimeout`	`getTimeout()` The timeout configuration for jobs that are submitted with this job definition.
`String`	`getType()` The type of job definition.
`int`	`hashCode()`
`Boolean`	`isPropagateTags()` Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setContainerProperties(ContainerProperties containerProperties)` An object with various properties specific to container-based jobs.
`void`	`setJobDefinitionArn(String jobDefinitionArn)` The Amazon Resource Name (ARN) for the job definition.
`void`	`setJobDefinitionName(String jobDefinitionName)` The name of the job definition.
`void`	`setNodeProperties(NodeProperties nodeProperties)` An object with various properties specific to multi-node parallel jobs.
`void`	`setParameters(Map<String,String> parameters)` Default parameters or parameter substitution placeholders that are set in the job definition.
`void`	`setPlatformCapabilities(Collection<String> platformCapabilities)` The platform capabilities required by the job definition.
`void`	`setPropagateTags(Boolean propagateTags)` Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task.
`void`	`setRetryStrategy(RetryStrategy retryStrategy)` The retry strategy to use for failed jobs that are submitted with this job definition.
`void`	`setRevision(Integer revision)` The revision of the job definition.
`void`	`setStatus(String status)` The status of the job definition.
`void`	`setTags(Map<String,String> tags)` The tags applied to the job definition.
`void`	`setTimeout(JobTimeout timeout)` The timeout configuration for jobs that are submitted with this job definition.
`void`	`setType(String type)` The type of job definition.
`String`	`toString()` Returns a string representation of this object.
`JobDefinition`	`withContainerProperties(ContainerProperties containerProperties)` An object with various properties specific to container-based jobs.
`JobDefinition`	`withJobDefinitionArn(String jobDefinitionArn)` The Amazon Resource Name (ARN) for the job definition.
`JobDefinition`	`withJobDefinitionName(String jobDefinitionName)` The name of the job definition.
`JobDefinition`	`withNodeProperties(NodeProperties nodeProperties)` An object with various properties specific to multi-node parallel jobs.
`JobDefinition`	`withParameters(Map<String,String> parameters)` Default parameters or parameter substitution placeholders that are set in the job definition.
`JobDefinition`	`withPlatformCapabilities(Collection<String> platformCapabilities)` The platform capabilities required by the job definition.
`JobDefinition`	`withPlatformCapabilities(PlatformCapability... platformCapabilities)` The platform capabilities required by the job definition.
`JobDefinition`	`withPlatformCapabilities(String... platformCapabilities)` The platform capabilities required by the job definition.
`JobDefinition`	`withPropagateTags(Boolean propagateTags)` Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task.
`JobDefinition`	`withRetryStrategy(RetryStrategy retryStrategy)` The retry strategy to use for failed jobs that are submitted with this job definition.
`JobDefinition`	`withRevision(Integer revision)` The revision of the job definition.
`JobDefinition`	`withStatus(String status)` The status of the job definition.
`JobDefinition`	`withTags(Map<String,String> tags)` The tags applied to the job definition.
`JobDefinition`	`withTimeout(JobTimeout timeout)` The timeout configuration for jobs that are submitted with this job definition.
`JobDefinition`	`withType(String type)` The type of job definition.

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

- Constructor Detail
  - JobDefinition
```
public JobDefinition()
```
- Method Detail
  - setJobDefinitionName
```
public void setJobDefinitionName(String jobDefinitionName)
```
    The name of the job definition.
    
    Parameters:
    
    jobDefinitionName - The name of the job definition.
  - getJobDefinitionName
```
public String getJobDefinitionName()
```
    The name of the job definition.
    
    Returns:
    
    The name of the job definition.
  - withJobDefinitionName
```
public JobDefinition withJobDefinitionName(String jobDefinitionName)
```
    The name of the job definition.
    
    Parameters:
    
    jobDefinitionName - The name of the job definition.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setJobDefinitionArn
```
public void setJobDefinitionArn(String jobDefinitionArn)
```
    The Amazon Resource Name (ARN) for the job definition.
    
    Parameters:
    
    jobDefinitionArn - The Amazon Resource Name (ARN) for the job definition.
  - getJobDefinitionArn
```
public String getJobDefinitionArn()
```
    The Amazon Resource Name (ARN) for the job definition.
    
    Returns:
    
    The Amazon Resource Name (ARN) for the job definition.
  - withJobDefinitionArn
```
public JobDefinition withJobDefinitionArn(String jobDefinitionArn)
```
    The Amazon Resource Name (ARN) for the job definition.
    
    Parameters:
    
    jobDefinitionArn - The Amazon Resource Name (ARN) for the job definition.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRevision
```
public void setRevision(Integer revision)
```
    The revision of the job definition.
    
    Parameters:
    
    revision - The revision of the job definition.
  - getRevision
```
public Integer getRevision()
```
    The revision of the job definition.
    
    Returns:
    
    The revision of the job definition.
  - withRevision
```
public JobDefinition withRevision(Integer revision)
```
    The revision of the job definition.
    
    Parameters:
    
    revision - The revision of the job definition.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatus
```
public void setStatus(String status)
```
    The status of the job definition.
    
    Parameters:
    
    status - The status of the job definition.
  - getStatus
```
public String getStatus()
```
    The status of the job definition.
    
    Returns:
    
    The status of the job definition.
  - withStatus
```
public JobDefinition withStatus(String status)
```
    The status of the job definition.
    
    Parameters:
    
    status - The status of the job definition.
    
    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. If the job is run on Fargate resources, then multinode isn't supported. For more information about multi-node parallel jobs, see Creating a multi-node parallel job definition in the Batch User Guide.
    
    Parameters:
    
    type - The type of job definition. If the job is run on Fargate resources, then multinode isn't supported. For more information about multi-node parallel jobs, see Creating a multi-node parallel job definition in the Batch User Guide.
  - getType
```
public String getType()
```
    The type of job definition. If the job is run on Fargate resources, then multinode isn't supported. For more information about multi-node parallel jobs, see Creating a multi-node parallel job definition in the Batch User Guide.
    
    Returns:
    
    The type of job definition. If the job is run on Fargate resources, then multinode isn't supported. For more information about multi-node parallel jobs, see Creating a multi-node parallel job definition in the Batch User Guide.
  - withType
```
public JobDefinition withType(String type)
```
    The type of job definition. If the job is run on Fargate resources, then multinode isn't supported. For more information about multi-node parallel jobs, see Creating a multi-node parallel job definition in the Batch User Guide.
    
    Parameters:
    
    type - The type of job definition. If the job is run on Fargate resources, then multinode isn't supported. For more information about multi-node parallel jobs, see Creating a multi-node parallel job definition in the Batch User Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getParameters
```
public Map<String,String> getParameters()
```
    Default parameters or parameter substitution placeholders that are 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. For more information about specifying parameters, see Job Definition Parameters in the Batch User Guide.
    
    Returns:
    
    Default parameters or parameter substitution placeholders that are 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. For more information about specifying parameters, see Job Definition Parameters in the Batch User Guide.
  - setParameters
```
public void setParameters(Map<String,String> parameters)
```
    Default parameters or parameter substitution placeholders that are 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. For more information about specifying parameters, see Job Definition Parameters in the Batch User Guide.
    
    Parameters:
    
    parameters - Default parameters or parameter substitution placeholders that are 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. For more information about specifying parameters, see Job Definition Parameters in the Batch User Guide.
  - withParameters
```
public JobDefinition withParameters(Map<String,String> parameters)
```
    Default parameters or parameter substitution placeholders that are 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. For more information about specifying parameters, see Job Definition Parameters in the Batch User Guide.
    
    Parameters:
    
    parameters - Default parameters or parameter substitution placeholders that are 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. For more information about specifying parameters, see Job Definition Parameters in the Batch User Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addParametersEntry
```
public JobDefinition addParametersEntry(String key,
                                        String value)
```
    Add a single Parameters entry
    
    See Also:
    
    withParameters(java.util.Map<java.lang.String, java.lang.String>)
  - clearParametersEntries
```
public JobDefinition clearParametersEntries()
```
    Removes all the entries added into Parameters.
    
    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.
    
    Parameters:
    
    retryStrategy - The retry strategy to use for failed jobs that are submitted with this job definition.
  - getRetryStrategy
```
public RetryStrategy getRetryStrategy()
```
    The retry strategy to use for failed jobs that are submitted with this job definition.
    
    Returns:
    
    The retry strategy to use for failed jobs that are submitted with this job definition.
  - withRetryStrategy
```
public JobDefinition withRetryStrategy(RetryStrategy retryStrategy)
```
    The retry strategy to use for failed jobs that are submitted with this job definition.
    
    Parameters:
    
    retryStrategy - The retry strategy to use for failed jobs that are submitted with this job definition.
    
    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 container-based jobs.
    
    Parameters:
    
    containerProperties - An object with various properties specific to container-based jobs.
  - getContainerProperties
```
public ContainerProperties getContainerProperties()
```
    An object with various properties specific to container-based jobs.
    
    Returns:
    
    An object with various properties specific to container-based jobs.
  - withContainerProperties
```
public JobDefinition withContainerProperties(ContainerProperties containerProperties)
```
    An object with various properties specific to container-based jobs.
    
    Parameters:
    
    containerProperties - An object with various properties specific to container-based jobs.
    
    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. You can specify a timeout duration after which Batch terminates your jobs if they haven't finished.
    
    Parameters:
    
    timeout - The timeout configuration for jobs that are submitted with this job definition. You can specify a timeout duration after which Batch terminates your jobs if they haven't finished.
  - getTimeout
```
public JobTimeout getTimeout()
```
    The timeout configuration for jobs that are submitted with this job definition. You can specify a timeout duration after which Batch terminates your jobs if they haven't finished.
    
    Returns:
    
    The timeout configuration for jobs that are submitted with this job definition. You can specify a timeout duration after which Batch terminates your jobs if they haven't finished.
  - withTimeout
```
public JobDefinition withTimeout(JobTimeout timeout)
```
    The timeout configuration for jobs that are submitted with this job definition. You can specify a timeout duration after which Batch terminates your jobs if they haven't finished.
    
    Parameters:
    
    timeout - The timeout configuration for jobs that are submitted with this job definition. You can specify a timeout duration after which Batch terminates your jobs if they haven't finished.
    
    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 the job runs on Fargate resources, then you must not specify nodeProperties; use containerProperties instead.
    
    Parameters:
    
    nodeProperties - An object with various properties specific to multi-node parallel jobs.
    
    If the job runs on Fargate resources, then you must not specify nodeProperties; use containerProperties instead.
  - getNodeProperties
```
public NodeProperties getNodeProperties()
```
    An object with various properties specific to multi-node parallel jobs.
    
    If the job runs on Fargate resources, then you must not specify nodeProperties; use containerProperties instead.
    
    Returns:
    
    An object with various properties specific to multi-node parallel jobs.
    
    If the job runs on Fargate resources, then you must not specify nodeProperties; use containerProperties instead.
  - withNodeProperties
```
public JobDefinition withNodeProperties(NodeProperties nodeProperties)
```
    An object with various properties specific to multi-node parallel jobs.
    
    If the job runs on Fargate resources, then you must not specify nodeProperties; use containerProperties instead.
    
    Parameters:
    
    nodeProperties - An object with various properties specific to multi-node parallel jobs.
    
    If the job runs on Fargate resources, then you must not specify nodeProperties; use containerProperties instead.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTags
```
public Map<String,String> getTags()
```
    The tags applied to the job definition.
    
    Returns:
    
    The tags applied to the job definition.
  - setTags
```
public void setTags(Map<String,String> tags)
```
    The tags applied to the job definition.
    
    Parameters:
    
    tags - The tags applied to the job definition.
  - withTags
```
public JobDefinition withTags(Map<String,String> tags)
```
    The tags applied to the job definition.
    
    Parameters:
    
    tags - The tags applied to the job definition.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addTagsEntry
```
public JobDefinition addTagsEntry(String key,
                                  String value)
```
    Add a single Tags entry
    
    See Also:
    
    withTags(java.util.Map<java.lang.String, java.lang.String>)
  - clearTagsEntries
```
public JobDefinition clearTagsEntries()
```
    Removes all the entries added into Tags.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPropagateTags
```
public void setPropagateTags(Boolean propagateTags)
```
    Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task. If no value is specified, the tags aren't propagated. Tags can only be propagated to the tasks during task creation. For tags with the same name, job tags are given priority over job definitions tags. If the total number of combined tags from the job and job definition is over 50, the job is moved to the FAILED state.
    
    Parameters:
    
    propagateTags - Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task. If no value is specified, the tags aren't propagated. Tags can only be propagated to the tasks during task creation. For tags with the same name, job tags are given priority over job definitions tags. If the total number of combined tags from the job and job definition is over 50, the job is moved to the FAILED state.
  - getPropagateTags
```
public Boolean getPropagateTags()
```
    Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task. If no value is specified, the tags aren't propagated. Tags can only be propagated to the tasks during task creation. For tags with the same name, job tags are given priority over job definitions tags. If the total number of combined tags from the job and job definition is over 50, the job is moved to the FAILED state.
    
    Returns:
    
    Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task. If no value is specified, the tags aren't propagated. Tags can only be propagated to the tasks during task creation. For tags with the same name, job tags are given priority over job definitions tags. If the total number of combined tags from the job and job definition is over 50, the job is moved to the FAILED state.
  - withPropagateTags
```
public JobDefinition withPropagateTags(Boolean propagateTags)
```
    Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task. If no value is specified, the tags aren't propagated. Tags can only be propagated to the tasks during task creation. For tags with the same name, job tags are given priority over job definitions tags. If the total number of combined tags from the job and job definition is over 50, the job is moved to the FAILED state.
    
    Parameters:
    
    propagateTags - Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task. If no value is specified, the tags aren't propagated. Tags can only be propagated to the tasks during task creation. For tags with the same name, job tags are given priority over job definitions tags. If the total number of combined tags from the job and job definition is over 50, the job is moved to the FAILED state.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isPropagateTags
```
public Boolean isPropagateTags()
```
    Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task. If no value is specified, the tags aren't propagated. Tags can only be propagated to the tasks during task creation. For tags with the same name, job tags are given priority over job definitions tags. If the total number of combined tags from the job and job definition is over 50, the job is moved to the FAILED state.
    
    Returns:
    
    Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task. If no value is specified, the tags aren't propagated. Tags can only be propagated to the tasks during task creation. For tags with the same name, job tags are given priority over job definitions tags. If the total number of combined tags from the job and job definition is over 50, the job is moved to the FAILED state.
  - getPlatformCapabilities
```
public List<String> getPlatformCapabilities()
```
    The platform capabilities required by the job definition. If no value is specified, it defaults to EC2. Jobs run on Fargate resources specify FARGATE.
    
    Returns:
    
    The platform capabilities required by the job definition. If no value is specified, it defaults to EC2. Jobs run on Fargate resources specify FARGATE.
    
    See Also:
    
    PlatformCapability
  - setPlatformCapabilities
```
public void setPlatformCapabilities(Collection<String> platformCapabilities)
```
    The platform capabilities required by the job definition. If no value is specified, it defaults to EC2. Jobs run on Fargate resources specify FARGATE.
    
    Parameters:
    
    platformCapabilities - The platform capabilities required by the job definition. If no value is specified, it defaults to EC2. Jobs run on Fargate resources specify FARGATE.
    
    See Also:
    
    PlatformCapability
  - withPlatformCapabilities
```
public JobDefinition withPlatformCapabilities(String... platformCapabilities)
```
    The platform capabilities required by the job definition. If no value is specified, it defaults to EC2. Jobs run on Fargate resources specify FARGATE.
    
    NOTE: This method appends the values to the existing list (if any). Use setPlatformCapabilities(java.util.Collection) or withPlatformCapabilities(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    platformCapabilities - The platform capabilities required by the job definition. If no value is specified, it defaults to EC2. Jobs run on Fargate resources specify FARGATE.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    PlatformCapability
  - withPlatformCapabilities
```
public JobDefinition withPlatformCapabilities(Collection<String> platformCapabilities)
```
    The platform capabilities required by the job definition. If no value is specified, it defaults to EC2. Jobs run on Fargate resources specify FARGATE.
    
    Parameters:
    
    platformCapabilities - The platform capabilities required by the job definition. If no value is specified, it defaults to EC2. Jobs run on Fargate resources specify FARGATE.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    PlatformCapability
  - withPlatformCapabilities
```
public JobDefinition withPlatformCapabilities(PlatformCapability... platformCapabilities)
```
    The platform capabilities required by the job definition. If no value is specified, it defaults to EC2. Jobs run on Fargate resources specify FARGATE.
    
    Parameters:
    
    platformCapabilities - The platform capabilities required by the job definition. If no value is specified, it defaults to EC2. Jobs run on Fargate resources specify FARGATE.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    PlatformCapability
  - 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 JobDefinition clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class JobDefinition

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

JobDefinition

Method Detail

setJobDefinitionName

getJobDefinitionName

withJobDefinitionName

setJobDefinitionArn

getJobDefinitionArn

withJobDefinitionArn

setRevision

getRevision

withRevision

setStatus

getStatus

withStatus

setType

getType

withType

getParameters

setParameters

withParameters

addParametersEntry

clearParametersEntries

setRetryStrategy

getRetryStrategy

withRetryStrategy

setContainerProperties

getContainerProperties

withContainerProperties

setTimeout

getTimeout

withTimeout

setNodeProperties

getNodeProperties

withNodeProperties

getTags

setTags

withTags

addTagsEntry

clearTagsEntries

setPropagateTags

getPropagateTags

withPropagateTags

isPropagateTags

getPlatformCapabilities

setPlatformCapabilities

withPlatformCapabilities

withPlatformCapabilities

withPlatformCapabilities

toString

equals

hashCode

clone

marshall