@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.
Constructor and Description |
---|
JobDetail() |
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) |
ArrayPropertiesDetail |
getArrayProperties()
The array properties of the job, if it is an array job.
|
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 (in seconds and milliseconds) for when the job was created.
|
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.
|
NodeDetails |
getNodeDetails()
An object representing the details of a node that is associated with a multi-node parallel job.
|
NodeProperties |
getNodeProperties()
An object representing the node properties of a multi-node parallel job.
|
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 (in seconds and milliseconds) for when the job was started (when the job transitioned from the
STARTING 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 (in seconds and milliseconds) for when the job was stopped (when the job transitioned from the
RUNNING state to a terminal state, such as SUCCEEDED or FAILED ). |
JobTimeout |
getTimeout()
The timeout configuration for the job.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setArrayProperties(ArrayPropertiesDetail arrayProperties)
The array properties of the job, if it is an array job.
|
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 (in seconds and milliseconds) for when the job was created.
|
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 |
setNodeDetails(NodeDetails nodeDetails)
An object representing the details of a node that is associated with a multi-node parallel job.
|
void |
setNodeProperties(NodeProperties nodeProperties)
An object representing the node properties of a multi-node parallel job.
|
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 (in seconds and milliseconds) for when the job was started (when the job transitioned from the
STARTING 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 (in seconds and milliseconds) for when the job was stopped (when the job transitioned from the
RUNNING state to a terminal state, such as SUCCEEDED or FAILED ). |
void |
setTimeout(JobTimeout timeout)
The timeout configuration for the job.
|
String |
toString()
Returns a string representation of this object.
|
JobDetail |
withArrayProperties(ArrayPropertiesDetail arrayProperties)
The array properties of the job, if it is an array job.
|
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 (in seconds and milliseconds) for when the job was created.
|
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 |
withNodeDetails(NodeDetails nodeDetails)
An object representing the details of a node that is associated with a multi-node parallel job.
|
JobDetail |
withNodeProperties(NodeProperties nodeProperties)
An object representing the node properties of a multi-node parallel job.
|
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 (in seconds and milliseconds) for when the job was started (when the job transitioned from the
STARTING 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 (in seconds and milliseconds) for when the job was stopped (when the job transitioned from the
RUNNING state to a terminal state, such as SUCCEEDED or FAILED ). |
JobDetail |
withTimeout(JobTimeout timeout)
The timeout configuration for the job.
|
public void setJobName(String jobName)
The name of the job.
jobName
- The name of the job.public String getJobName()
The name of the job.
public JobDetail withJobName(String jobName)
The name of the job.
jobName
- The name of the job.public void setJobId(String jobId)
The ID for the job.
jobId
- The ID for the job.public String getJobId()
The ID for the job.
public JobDetail withJobId(String jobId)
The ID for the job.
jobId
- The ID for the job.public void setJobQueue(String jobQueue)
The Amazon Resource Name (ARN) of the job queue with which the job is associated.
jobQueue
- The Amazon Resource Name (ARN) of the job queue with which the job is associated.public String getJobQueue()
The Amazon Resource Name (ARN) of the job queue with which the job is associated.
public JobDetail withJobQueue(String jobQueue)
The Amazon Resource Name (ARN) of the job queue with which the job is associated.
jobQueue
- The Amazon Resource Name (ARN) of the job queue with which the job is associated.public void setStatus(String status)
The current status for the job.
If your jobs do not progress to STARTING
, see Jobs Stuck
in RUNNABLE Status in the troubleshooting section of the AWS Batch User Guide.
status
- The current status for the job.
If your jobs do not progress to STARTING
, see Jobs
Stuck in RUNNABLE Status in the troubleshooting section of the AWS Batch User Guide.
JobStatus
public String getStatus()
The current status for the job.
If your jobs do not progress to STARTING
, see Jobs Stuck
in RUNNABLE Status in the troubleshooting section of the AWS Batch User Guide.
If your jobs do not progress to STARTING
, see Jobs
Stuck in RUNNABLE Status in the troubleshooting section of the AWS Batch User Guide.
JobStatus
public JobDetail withStatus(String status)
The current status for the job.
If your jobs do not progress to STARTING
, see Jobs Stuck
in RUNNABLE Status in the troubleshooting section of the AWS Batch User Guide.
status
- The current status for the job.
If your jobs do not progress to STARTING
, see Jobs
Stuck in RUNNABLE Status in the troubleshooting section of the AWS Batch User Guide.
JobStatus
public void setStatus(JobStatus status)
The current status for the job.
If your jobs do not progress to STARTING
, see Jobs Stuck
in RUNNABLE Status in the troubleshooting section of the AWS Batch User Guide.
status
- The current status for the job.
If your jobs do not progress to STARTING
, see Jobs
Stuck in RUNNABLE Status in the troubleshooting section of the AWS Batch User Guide.
JobStatus
public JobDetail withStatus(JobStatus status)
The current status for the job.
If your jobs do not progress to STARTING
, see Jobs Stuck
in RUNNABLE Status in the troubleshooting section of the AWS Batch User Guide.
status
- The current status for the job.
If your jobs do not progress to STARTING
, see Jobs
Stuck in RUNNABLE Status in the troubleshooting section of the AWS Batch User Guide.
JobStatus
public List<AttemptDetail> getAttempts()
A list of job attempts associated with this job.
public void setAttempts(Collection<AttemptDetail> attempts)
A list of job attempts associated with this job.
attempts
- A list of job attempts associated with this job.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.
attempts
- A list of job attempts associated with this job.public JobDetail withAttempts(Collection<AttemptDetail> attempts)
A list of job attempts associated with this job.
attempts
- A list of job attempts associated with this job.public void setStatusReason(String statusReason)
A short, human-readable string to provide additional details about the current status of the job.
statusReason
- A short, human-readable string to provide additional details about the current status of the job.public String getStatusReason()
A short, human-readable string to provide additional details about the current status of the job.
public JobDetail withStatusReason(String statusReason)
A short, human-readable string to provide additional details about the current status of the job.
statusReason
- A short, human-readable string to provide additional details about the current status of the job.public void setCreatedAt(Long createdAt)
The Unix timestamp (in seconds and milliseconds) for when the job was created. For non-array jobs and parent
array jobs, this is when the job entered the SUBMITTED
state (at the time SubmitJob was
called). For array child jobs, this is when the child job was spawned by its parent and entered the
PENDING
state.
createdAt
- The Unix timestamp (in seconds and milliseconds) for when the job was created. For non-array jobs and
parent array jobs, this is when the job entered the SUBMITTED
state (at the time
SubmitJob was called). For array child jobs, this is when the child job was spawned by its parent
and entered the PENDING
state.public Long getCreatedAt()
The Unix timestamp (in seconds and milliseconds) for when the job was created. For non-array jobs and parent
array jobs, this is when the job entered the SUBMITTED
state (at the time SubmitJob was
called). For array child jobs, this is when the child job was spawned by its parent and entered the
PENDING
state.
SUBMITTED
state (at the time
SubmitJob was called). For array child jobs, this is when the child job was spawned by its parent
and entered the PENDING
state.public JobDetail withCreatedAt(Long createdAt)
The Unix timestamp (in seconds and milliseconds) for when the job was created. For non-array jobs and parent
array jobs, this is when the job entered the SUBMITTED
state (at the time SubmitJob was
called). For array child jobs, this is when the child job was spawned by its parent and entered the
PENDING
state.
createdAt
- The Unix timestamp (in seconds and milliseconds) for when the job was created. For non-array jobs and
parent array jobs, this is when the job entered the SUBMITTED
state (at the time
SubmitJob was called). For array child jobs, this is when the child job was spawned by its parent
and entered the PENDING
state.public void setRetryStrategy(RetryStrategy retryStrategy)
The retry strategy to use for this job if an attempt fails.
retryStrategy
- The retry strategy to use for this job if an attempt fails.public RetryStrategy getRetryStrategy()
The retry strategy to use for this job if an attempt fails.
public JobDetail withRetryStrategy(RetryStrategy retryStrategy)
The retry strategy to use for this job if an attempt fails.
retryStrategy
- The retry strategy to use for this job if an attempt fails.public void setStartedAt(Long startedAt)
The Unix timestamp (in seconds and milliseconds) for when the job was started (when the job transitioned from the
STARTING
state to the RUNNING
state).
startedAt
- The Unix timestamp (in seconds and milliseconds) for when the job was started (when the job transitioned
from the STARTING
state to the RUNNING
state).public Long getStartedAt()
The Unix timestamp (in seconds and milliseconds) for when the job was started (when the job transitioned from the
STARTING
state to the RUNNING
state).
STARTING
state to the RUNNING
state).public JobDetail withStartedAt(Long startedAt)
The Unix timestamp (in seconds and milliseconds) for when the job was started (when the job transitioned from the
STARTING
state to the RUNNING
state).
startedAt
- The Unix timestamp (in seconds and milliseconds) for when the job was started (when the job transitioned
from the STARTING
state to the RUNNING
state).public void setStoppedAt(Long stoppedAt)
The Unix timestamp (in seconds and milliseconds) for when the job was stopped (when the job transitioned from the
RUNNING
state to a terminal state, such as SUCCEEDED
or FAILED
).
stoppedAt
- The Unix timestamp (in seconds and milliseconds) for when the job was stopped (when the job transitioned
from the RUNNING
state to a terminal state, such as SUCCEEDED
or
FAILED
).public Long getStoppedAt()
The Unix timestamp (in seconds and milliseconds) for when the job was stopped (when the job transitioned from the
RUNNING
state to a terminal state, such as SUCCEEDED
or FAILED
).
RUNNING
state to a terminal state, such as SUCCEEDED
or
FAILED
).public JobDetail withStoppedAt(Long stoppedAt)
The Unix timestamp (in seconds and milliseconds) for when the job was stopped (when the job transitioned from the
RUNNING
state to a terminal state, such as SUCCEEDED
or FAILED
).
stoppedAt
- The Unix timestamp (in seconds and milliseconds) for when the job was stopped (when the job transitioned
from the RUNNING
state to a terminal state, such as SUCCEEDED
or
FAILED
).public List<JobDependency> getDependsOn()
A list of job names or IDs on which this job depends.
public void setDependsOn(Collection<JobDependency> dependsOn)
A list of job names or IDs on which this job depends.
dependsOn
- A list of job names or IDs on which this job depends.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.
dependsOn
- A list of job names or IDs on which this job depends.public JobDetail withDependsOn(Collection<JobDependency> dependsOn)
A list of job names or IDs on which this job depends.
dependsOn
- A list of job names or IDs on which this job depends.public void setJobDefinition(String jobDefinition)
The job definition that is used by this job.
jobDefinition
- The job definition that is used by this job.public String getJobDefinition()
The job definition that is used by this job.
public JobDetail withJobDefinition(String jobDefinition)
The job definition that is used by this job.
jobDefinition
- The job definition that is used by this job.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.
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
- Additional parameters passed to the job that replace parameter substitution placeholders or override any
corresponding parameter defaults from the job definition.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
- Additional parameters passed to the job that replace parameter substitution placeholders or override any
corresponding parameter defaults from the job definition.public JobDetail clearParametersEntries()
public void setContainer(ContainerDetail container)
An object representing the details of the container that is associated with the job.
container
- An object representing the details of the container that is associated with the job.public ContainerDetail getContainer()
An object representing the details of the container that is associated with the job.
public JobDetail withContainer(ContainerDetail container)
An object representing the details of the container that is associated with the job.
container
- An object representing the details of the container that is associated with the job.public void setNodeDetails(NodeDetails nodeDetails)
An object representing the details of a node that is associated with a multi-node parallel job.
nodeDetails
- An object representing the details of a node that is associated with a multi-node parallel job.public NodeDetails getNodeDetails()
An object representing the details of a node that is associated with a multi-node parallel job.
public JobDetail withNodeDetails(NodeDetails nodeDetails)
An object representing the details of a node that is associated with a multi-node parallel job.
nodeDetails
- An object representing the details of a node that is associated with a multi-node parallel job.public void setNodeProperties(NodeProperties nodeProperties)
An object representing the node properties of a multi-node parallel job.
nodeProperties
- An object representing the node properties of a multi-node parallel job.public NodeProperties getNodeProperties()
An object representing the node properties of a multi-node parallel job.
public JobDetail withNodeProperties(NodeProperties nodeProperties)
An object representing the node properties of a multi-node parallel job.
nodeProperties
- An object representing the node properties of a multi-node parallel job.public void setArrayProperties(ArrayPropertiesDetail arrayProperties)
The array properties of the job, if it is an array job.
arrayProperties
- The array properties of the job, if it is an array job.public ArrayPropertiesDetail getArrayProperties()
The array properties of the job, if it is an array job.
public JobDetail withArrayProperties(ArrayPropertiesDetail arrayProperties)
The array properties of the job, if it is an array job.
arrayProperties
- The array properties of the job, if it is an array job.public void setTimeout(JobTimeout timeout)
The timeout configuration for the job.
timeout
- The timeout configuration for the job.public JobTimeout getTimeout()
The timeout configuration for the job.
public JobDetail withTimeout(JobTimeout timeout)
The timeout configuration for the job.
timeout
- The timeout configuration for the job.public String toString()
toString
in class Object
Object.toString()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.