JobDetail (AWS SDK for Java

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

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class JobDetail
extends Object
implements Serializable, Cloneable, StructuredPojo

An object representing an AWS Batch job.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

JobDetail()

Constructors
Constructor and Description
`JobDetail()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`JobDetail`	`addParametersEntry(String key, String value)`
`JobDetail`	`clearParametersEntries()` Removes all the entries added into Parameters.
`JobDetail`	`clone()`
`boolean`	`equals(Object obj)`
`List<AttemptDetail>`	`getAttempts()` A list of job attempts associated with this job.
`ContainerDetail`	`getContainer()` An object representing the details of the container that is associated with the job.
`Long`	`getCreatedAt()` The Unix timestamp for when the job was created (when the task entered the `PENDING` state).
`List<JobDependency>`	`getDependsOn()` A list of job names or IDs on which this job depends.
`String`	`getJobDefinition()` The job definition that is used by this job.
`String`	`getJobId()` The ID for the job.
`String`	`getJobName()` The name of the job.
`String`	`getJobQueue()` The Amazon Resource Name (ARN) of the job queue with which the job is associated.
`Map<String,String>`	`getParameters()` Additional parameters passed to the job that replace parameter substitution placeholders or override any corresponding parameter defaults from the job definition.
`RetryStrategy`	`getRetryStrategy()` The retry strategy to use for this job if an attempt fails.
`Long`	`getStartedAt()` The Unix timestamp for when the job was started (when the task transitioned from the `PENDING` state to the `RUNNING` state).
`String`	`getStatus()` The current status for the job.
`String`	`getStatusReason()` A short, human-readable string to provide additional details about the current status of the job.
`Long`	`getStoppedAt()` The Unix timestamp for when the job was stopped (when the task transitioned from the `RUNNING` state to the `STOPPED` state).
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAttempts(Collection<AttemptDetail> attempts)` A list of job attempts associated with this job.
`void`	`setContainer(ContainerDetail container)` An object representing the details of the container that is associated with the job.
`void`	`setCreatedAt(Long createdAt)` The Unix timestamp for when the job was created (when the task entered the `PENDING` state).
`void`	`setDependsOn(Collection<JobDependency> dependsOn)` A list of job names or IDs on which this job depends.
`void`	`setJobDefinition(String jobDefinition)` The job definition that is used by this job.
`void`	`setJobId(String jobId)` The ID for the job.
`void`	`setJobName(String jobName)` The name of the job.
`void`	`setJobQueue(String jobQueue)` The Amazon Resource Name (ARN) of the job queue with which the job is associated.
`void`	`setParameters(Map<String,String> parameters)` Additional parameters passed to the job that replace parameter substitution placeholders or override any corresponding parameter defaults from the job definition.
`void`	`setRetryStrategy(RetryStrategy retryStrategy)` The retry strategy to use for this job if an attempt fails.
`void`	`setStartedAt(Long startedAt)` The Unix timestamp for when the job was started (when the task transitioned from the `PENDING` state to the `RUNNING` state).
`void`	`setStatus(JobStatus status)` The current status for the job.
`void`	`setStatus(String status)` The current status for the job.
`void`	`setStatusReason(String statusReason)` A short, human-readable string to provide additional details about the current status of the job.
`void`	`setStoppedAt(Long stoppedAt)` The Unix timestamp for when the job was stopped (when the task transitioned from the `RUNNING` state to the `STOPPED` state).
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`JobDetail`	`withAttempts(AttemptDetail... attempts)` A list of job attempts associated with this job.
`JobDetail`	`withAttempts(Collection<AttemptDetail> attempts)` A list of job attempts associated with this job.
`JobDetail`	`withContainer(ContainerDetail container)` An object representing the details of the container that is associated with the job.
`JobDetail`	`withCreatedAt(Long createdAt)` The Unix timestamp for when the job was created (when the task entered the `PENDING` state).
`JobDetail`	`withDependsOn(Collection<JobDependency> dependsOn)` A list of job names or IDs on which this job depends.
`JobDetail`	`withDependsOn(JobDependency... dependsOn)` A list of job names or IDs on which this job depends.
`JobDetail`	`withJobDefinition(String jobDefinition)` The job definition that is used by this job.
`JobDetail`	`withJobId(String jobId)` The ID for the job.
`JobDetail`	`withJobName(String jobName)` The name of the job.
`JobDetail`	`withJobQueue(String jobQueue)` The Amazon Resource Name (ARN) of the job queue with which the job is associated.
`JobDetail`	`withParameters(Map<String,String> parameters)` Additional parameters passed to the job that replace parameter substitution placeholders or override any corresponding parameter defaults from the job definition.
`JobDetail`	`withRetryStrategy(RetryStrategy retryStrategy)` The retry strategy to use for this job if an attempt fails.
`JobDetail`	`withStartedAt(Long startedAt)` The Unix timestamp for when the job was started (when the task transitioned from the `PENDING` state to the `RUNNING` state).
`JobDetail`	`withStatus(JobStatus status)` The current status for the job.
`JobDetail`	`withStatus(String status)` The current status for the job.
`JobDetail`	`withStatusReason(String statusReason)` A short, human-readable string to provide additional details about the current status of the job.
`JobDetail`	`withStoppedAt(Long stoppedAt)` The Unix timestamp for when the job was stopped (when the task transitioned from the `RUNNING` state to the `STOPPED` state).

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

- Constructor Detail
  - JobDetail
```
public JobDetail()
```
- Method Detail
  - setJobName
```
public void setJobName(String jobName)
```
    The name of the job.
    
    Parameters:
    
    jobName - The name of the job.
  - getJobName
```
public String getJobName()
```
    The name of the job.
    
    Returns:
    
    The name of the job.
  - withJobName
```
public JobDetail withJobName(String jobName)
```
    The name of the job.
    
    Parameters:
    
    jobName - The name of the job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setJobId
```
public void setJobId(String jobId)
```
    The ID for the job.
    
    Parameters:
    
    jobId - The ID for the job.
  - getJobId
```
public String getJobId()
```
    The ID for the job.
    
    Returns:
    
    The ID for the job.
  - withJobId
```
public JobDetail withJobId(String jobId)
```
    The ID for the job.
    
    Parameters:
    
    jobId - The ID for the job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setJobQueue
```
public void setJobQueue(String jobQueue)
```
    The Amazon Resource Name (ARN) of the job queue with which the job is associated.
    
    Parameters:
    
    jobQueue - The Amazon Resource Name (ARN) of the job queue with which the job is associated.
  - getJobQueue
```
public String getJobQueue()
```
    The Amazon Resource Name (ARN) of the job queue with which the job is associated.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the job queue with which the job is associated.
  - withJobQueue
```
public JobDetail withJobQueue(String jobQueue)
```
    The Amazon Resource Name (ARN) of the job queue with which the job is associated.
    
    Parameters:
    
    jobQueue - The Amazon Resource Name (ARN) of the job queue with which the job is associated.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatus
```
public void setStatus(String status)
```
    The current status for the job.
    
    Parameters:
    
    status - The current status for the job.
    
    See Also:
    
    JobStatus
  - getStatus
```
public String getStatus()
```
    The current status for the job.
    
    Returns:
    
    The current status for the job.
    
    See Also:
    
    JobStatus
  - withStatus
```
public JobDetail withStatus(String status)
```
    The current status for the job.
    
    Parameters:
    
    status - The current status for the job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    JobStatus
  - setStatus
```
public void setStatus(JobStatus status)
```
    The current status for the job.
    
    Parameters:
    
    status - The current status for the job.
    
    See Also:
    
    JobStatus
  - withStatus
```
public JobDetail withStatus(JobStatus status)
```
    The current status for the job.
    
    Parameters:
    
    status - The current status for the job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    JobStatus
  - getAttempts
```
public List<AttemptDetail> getAttempts()
```
    A list of job attempts associated with this job.
    
    Returns:
    
    A list of job attempts associated with this job.
  - setAttempts
```
public void setAttempts(Collection<AttemptDetail> attempts)
```
    A list of job attempts associated with this job.
    
    Parameters:
    
    attempts - A list of job attempts associated with this job.
  - withAttempts
```
public JobDetail withAttempts(AttemptDetail... attempts)
```
    A list of job attempts associated with this job.
    
    NOTE: This method appends the values to the existing list (if any). Use setAttempts(java.util.Collection) or withAttempts(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    attempts - A list of job attempts associated with this job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withAttempts
```
public JobDetail withAttempts(Collection<AttemptDetail> attempts)
```
    A list of job attempts associated with this job.
    
    Parameters:
    
    attempts - A list of job attempts associated with this job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatusReason
```
public void setStatusReason(String statusReason)
```
    A short, human-readable string to provide additional details about the current status of the job.
    
    Parameters:
    
    statusReason - A short, human-readable string to provide additional details about the current status of the job.
  - getStatusReason
```
public String getStatusReason()
```
    A short, human-readable string to provide additional details about the current status of the job.
    
    Returns:
    
    A short, human-readable string to provide additional details about the current status of the job.
  - withStatusReason
```
public JobDetail withStatusReason(String statusReason)
```
    A short, human-readable string to provide additional details about the current status of the job.
    
    Parameters:
    
    statusReason - A short, human-readable string to provide additional details about the current status of the job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreatedAt
```
public void setCreatedAt(Long createdAt)
```
    The Unix timestamp for when the job was created (when the task entered the PENDING state).
    
    Parameters:
    
    createdAt - The Unix timestamp for when the job was created (when the task entered the PENDING state).
  - getCreatedAt
```
public Long getCreatedAt()
```
    The Unix timestamp for when the job was created (when the task entered the PENDING state).
    
    Returns:
    
    The Unix timestamp for when the job was created (when the task entered the PENDING state).
  - withCreatedAt
```
public JobDetail withCreatedAt(Long createdAt)
```
    The Unix timestamp for when the job was created (when the task entered the PENDING state).
    
    Parameters:
    
    createdAt - The Unix timestamp for when the job was created (when the task entered the PENDING state).
    
    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 this job if an attempt fails.
    
    Parameters:
    
    retryStrategy - The retry strategy to use for this job if an attempt fails.
  - getRetryStrategy
```
public RetryStrategy getRetryStrategy()
```
    The retry strategy to use for this job if an attempt fails.
    
    Returns:
    
    The retry strategy to use for this job if an attempt fails.
  - withRetryStrategy
```
public JobDetail withRetryStrategy(RetryStrategy retryStrategy)
```
    The retry strategy to use for this job if an attempt fails.
    
    Parameters:
    
    retryStrategy - The retry strategy to use for this job if an attempt fails.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStartedAt
```
public void setStartedAt(Long startedAt)
```
    The Unix timestamp for when the job was started (when the task transitioned from the PENDING state to the RUNNING state).
    
    Parameters:
    
    startedAt - The Unix timestamp for when the job was started (when the task transitioned from the PENDING state to the RUNNING state).
  - getStartedAt
```
public Long getStartedAt()
```
    The Unix timestamp for when the job was started (when the task transitioned from the PENDING state to the RUNNING state).
    
    Returns:
    
    The Unix timestamp for when the job was started (when the task transitioned from the PENDING state to the RUNNING state).
  - withStartedAt
```
public JobDetail withStartedAt(Long startedAt)
```
    The Unix timestamp for when the job was started (when the task transitioned from the PENDING state to the RUNNING state).
    
    Parameters:
    
    startedAt - The Unix timestamp for when the job was started (when the task transitioned from the PENDING state to the RUNNING state).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStoppedAt
```
public void setStoppedAt(Long stoppedAt)
```
    The Unix timestamp for when the job was stopped (when the task transitioned from the RUNNING state to the STOPPED state).
    
    Parameters:
    
    stoppedAt - The Unix timestamp for when the job was stopped (when the task transitioned from the RUNNING state to the STOPPED state).
  - getStoppedAt
```
public Long getStoppedAt()
```
    The Unix timestamp for when the job was stopped (when the task transitioned from the RUNNING state to the STOPPED state).
    
    Returns:
    
    The Unix timestamp for when the job was stopped (when the task transitioned from the RUNNING state to the STOPPED state).
  - withStoppedAt
```
public JobDetail withStoppedAt(Long stoppedAt)
```
    The Unix timestamp for when the job was stopped (when the task transitioned from the RUNNING state to the STOPPED state).
    
    Parameters:
    
    stoppedAt - The Unix timestamp for when the job was stopped (when the task transitioned from the RUNNING state to the STOPPED state).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getDependsOn
```
public List<JobDependency> getDependsOn()
```
    A list of job names or IDs on which this job depends.
    
    Returns:
    
    A list of job names or IDs on which this job depends.
  - setDependsOn
```
public void setDependsOn(Collection<JobDependency> dependsOn)
```
    A list of job names or IDs on which this job depends.
    
    Parameters:
    
    dependsOn - A list of job names or IDs on which this job depends.
  - withDependsOn
```
public JobDetail withDependsOn(JobDependency... dependsOn)
```
    A list of job names or IDs on which this job depends.
    
    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 names or IDs on which this job depends.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withDependsOn
```
public JobDetail withDependsOn(Collection<JobDependency> dependsOn)
```
    A list of job names or IDs on which this job depends.
    
    Parameters:
    
    dependsOn - A list of job names or IDs on which this job depends.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setJobDefinition
```
public void setJobDefinition(String jobDefinition)
```
    The job definition that is used by this job.
    
    Parameters:
    
    jobDefinition - The job definition that is used by this job.
  - getJobDefinition
```
public String getJobDefinition()
```
    The job definition that is used by this job.
    
    Returns:
    
    The job definition that is used by this job.
  - withJobDefinition
```
public JobDetail withJobDefinition(String jobDefinition)
```
    The job definition that is used by this job.
    
    Parameters:
    
    jobDefinition - The job definition that is used by this job.
    
    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 or override any corresponding parameter defaults from the job definition.
    
    Returns:
    
    Additional parameters passed to the job that replace parameter substitution placeholders or 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 or override any corresponding parameter defaults from the job definition.
    
    Parameters:
    
    parameters - Additional parameters passed to the job that replace parameter substitution placeholders or override any corresponding parameter defaults from the job definition.
  - withParameters
```
public JobDetail withParameters(Map<String,String> parameters)
```
    Additional parameters passed to the job that replace parameter substitution placeholders or override any corresponding parameter defaults from the job definition.
    
    Parameters:
    
    parameters - Additional parameters passed to the job that replace parameter substitution placeholders or 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 JobDetail addParametersEntry(String key,
                                    String value)
```
  - clearParametersEntries
```
public JobDetail clearParametersEntries()
```
    Removes all the entries added into Parameters.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setContainer
```
public void setContainer(ContainerDetail container)
```
    An object representing the details of the container that is associated with the job.
    
    Parameters:
    
    container - An object representing the details of the container that is associated with the job.
  - getContainer
```
public ContainerDetail getContainer()
```
    An object representing the details of the container that is associated with the job.
    
    Returns:
    
    An object representing the details of the container that is associated with the job.
  - withContainer
```
public JobDetail withContainer(ContainerDetail container)
```
    An object representing the details of the container that is associated with the job.
    
    Parameters:
    
    container - An object representing the details of the container that is associated with the job.
    
    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 JobDetail 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 JobDetail

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

JobDetail

Method Detail

setJobName

getJobName

withJobName

setJobId

getJobId

withJobId

setJobQueue

getJobQueue

withJobQueue

setStatus

getStatus

withStatus

setStatus

withStatus

getAttempts

setAttempts

withAttempts

withAttempts

setStatusReason

getStatusReason

withStatusReason

setCreatedAt

getCreatedAt

withCreatedAt

setRetryStrategy

getRetryStrategy

withRetryStrategy

setStartedAt

getStartedAt

withStartedAt

setStoppedAt

getStoppedAt

withStoppedAt

getDependsOn

setDependsOn

withDependsOn

withDependsOn

setJobDefinition

getJobDefinition

withJobDefinition

getParameters

setParameters

withParameters

addParametersEntry

clearParametersEntries

setContainer

getContainer

withContainer

toString

equals

hashCode

clone

marshall