@Generated(value="software.amazon.awssdk:codegen") public final class JobExecution extends Object implements SdkPojo, Serializable, ToCopyableBuilder<JobExecution.Builder,JobExecution>
Contains data about a job execution.
Modifier and Type | Class and Description |
---|---|
static interface |
JobExecution.Builder |
Modifier and Type | Method and Description |
---|---|
Long |
approximateSecondsBeforeTimedOut()
The estimated number of seconds that remain before the job execution status will be changed to
TIMED_OUT . |
static JobExecution.Builder |
builder() |
boolean |
equals(Object obj) |
Long |
executionNumber()
A number that identifies a particular job execution on a particular device.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
String |
jobDocument()
The content of the job document.
|
String |
jobId()
The unique identifier you assigned to this job when it was created.
|
Long |
lastUpdatedAt()
The time, in milliseconds since the epoch, when the job execution was last updated.
|
Long |
queuedAt()
The time, in milliseconds since the epoch, when the job execution was enqueued.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends JobExecution.Builder> |
serializableBuilderClass() |
Long |
startedAt()
The time, in milliseconds since the epoch, when the job execution was started.
|
JobExecutionStatus |
status()
The status of the job execution.
|
String |
statusAsString()
The status of the job execution.
|
Map<String,String> |
statusDetails()
A collection of name/value pairs that describe the status of the job execution.
|
String |
thingName()
The name of the thing that is executing the job.
|
JobExecution.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
Long |
versionNumber()
The version of the job execution.
|
copy
public String jobId()
The unique identifier you assigned to this job when it was created.
public String thingName()
The name of the thing that is executing the job.
public JobExecutionStatus status()
The status of the job execution. Can be one of: "QUEUED", "IN_PROGRESS", "FAILED", "SUCCESS", "CANCELED", "REJECTED", or "REMOVED".
If the service returns an enum value that is not available in the current SDK version, status
will
return JobExecutionStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
statusAsString()
.
JobExecutionStatus
public String statusAsString()
The status of the job execution. Can be one of: "QUEUED", "IN_PROGRESS", "FAILED", "SUCCESS", "CANCELED", "REJECTED", or "REMOVED".
If the service returns an enum value that is not available in the current SDK version, status
will
return JobExecutionStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
statusAsString()
.
JobExecutionStatus
public Map<String,String> statusDetails()
A collection of name/value pairs that describe the status of the job execution.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public Long queuedAt()
The time, in milliseconds since the epoch, when the job execution was enqueued.
public Long startedAt()
The time, in milliseconds since the epoch, when the job execution was started.
public Long lastUpdatedAt()
The time, in milliseconds since the epoch, when the job execution was last updated.
public Long approximateSecondsBeforeTimedOut()
The estimated number of seconds that remain before the job execution status will be changed to
TIMED_OUT
.
TIMED_OUT
.public Long versionNumber()
The version of the job execution. Job execution versions are incremented each time they are updated by a device.
public Long executionNumber()
A number that identifies a particular job execution on a particular device. It can be used later in commands that return or update job execution information.
public String jobDocument()
The content of the job document.
public JobExecution.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<JobExecution.Builder,JobExecution>
public static JobExecution.Builder builder()
public static Class<? extends JobExecution.Builder> serializableBuilderClass()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.