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 AWS 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)`
`JobDefinition`	`clearParametersEntries()` Removes all the entries added into Parameters.
`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.
`Map<String,String>`	`getParameters()` Default parameters or parameter substitution placeholders that are set in the job definition.
`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.
`String`	`getType()` The type of job definition.
`int`	`hashCode()`
`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`	`setParameters(Map<String,String> parameters)` Default parameters or parameter substitution placeholders that are 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`	`setRevision(Integer revision)` The revision of the job definition.
`void`	`setStatus(String status)` The status of the job definition.
`void`	`setType(String type)` The type of job definition.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`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`	`withParameters(Map<String,String> parameters)` Default parameters or parameter substitution placeholders that are set in the job definition.
`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`	`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.
    
    Parameters:
    
    type - The type of job definition.
  - getType
```
public String getType()
```
    The type of job definition.
    
    Returns:
    
    The type of job definition.
  - withType
```
public JobDefinition 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.
  - 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.
    
    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.
  - 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.
    
    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.
  - 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.
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addParametersEntry
```
public JobDefinition addParametersEntry(String key,
                                        String value)
```
  - 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.
  - 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 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

toString

equals

hashCode

clone

marshall