@Generated(value="software.amazon.awssdk:codegen") public class JobDetail extends Object implements StructuredPojo, ToCopyableBuilder<JobDetail.Builder,JobDetail>
An object representing an AWS Batch job.
Modifier and Type | Class and Description |
---|---|
static interface |
JobDetail.Builder |
Modifier and Type | Method and Description |
---|---|
List<AttemptDetail> |
attempts()
A list of job attempts associated with this job.
|
static JobDetail.Builder |
builder() |
ContainerDetail |
container()
An object representing the details of the container that is associated with the job.
|
Long |
createdAt()
The Unix timestamp for when the job was created (when the task entered the
PENDING state). |
List<JobDependency> |
dependsOn()
A list of job names or IDs on which this job depends.
|
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
String |
jobDefinition()
The job definition that is used by this job.
|
String |
jobId()
The ID for the job.
|
String |
jobName()
The name of the job.
|
String |
jobQueue()
The Amazon Resource Name (ARN) of the job queue with which the job is associated.
|
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
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.
|
RetryStrategy |
retryStrategy()
The retry strategy to use for this job if an attempt fails.
|
static Class<? extends JobDetail.Builder> |
serializableBuilderClass() |
Long |
startedAt()
The Unix timestamp for when the job was started (when the task transitioned from the
PENDING state
to the RUNNING state). |
JobStatus |
status()
The current status for the job.
|
String |
statusReason()
A short, human-readable string to provide additional details about the current status of the job.
|
String |
statusString()
The current status for the job.
|
Long |
stoppedAt()
The Unix timestamp for when the job was stopped (when the task transitioned from the
RUNNING state
to the STOPPED state). |
JobDetail.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
copy
public String jobName()
The name of the job.
public String jobId()
The ID for the job.
public String jobQueue()
The Amazon Resource Name (ARN) of the job queue with which the job is associated.
public JobStatus status()
The current status for the job.
If the service returns an enum value that is not available in the current SDK version, status
will
return JobStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
statusString()
.
JobStatus
public String statusString()
The current status for the job.
If the service returns an enum value that is not available in the current SDK version, status
will
return JobStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
statusString()
.
JobStatus
public List<AttemptDetail> attempts()
A list of job attempts associated with this job.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public String statusReason()
A short, human-readable string to provide additional details about the current status of the job.
public Long createdAt()
The Unix timestamp for when the job was created (when the task entered the PENDING
state).
PENDING
state).public RetryStrategy retryStrategy()
The retry strategy to use for this job if an attempt fails.
public Long startedAt()
The Unix timestamp for when the job was started (when the task transitioned from the PENDING
state
to the RUNNING
state).
PENDING
state to the RUNNING
state).public Long stoppedAt()
The Unix timestamp for when the job was stopped (when the task transitioned from the RUNNING
state
to the STOPPED
state).
RUNNING
state to the STOPPED
state).public List<JobDependency> dependsOn()
A list of job names or IDs on which this job depends.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public String jobDefinition()
The job definition that is used by this job.
public 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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public ContainerDetail container()
An object representing the details of the container that is associated with the job.
public JobDetail.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<JobDetail.Builder,JobDetail>
public static JobDetail.Builder builder()
public static Class<? extends JobDetail.Builder> serializableBuilderClass()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.