Class JobExecution
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<JobExecution.Builder,
JobExecution>
The job execution object represents the execution of a job on a particular device.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal Long
The estimated number of seconds that remain before the job execution status will be changed toTIMED_OUT
.static JobExecution.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final Long
A string (consisting of the digits "0" through "9") which identifies this particular job execution on this particular device.final Boolean
Will betrue
if the job execution was canceled with the optionalforce
parameter set totrue
.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final String
jobId()
The unique identifier you assigned to the job when it was created.final Instant
The time, in seconds since the epoch, when the job execution was last updated.final Instant
queuedAt()
The time, in seconds since the epoch, when the job execution was queued.static Class
<? extends JobExecution.Builder> final Instant
The time, in seconds since the epoch, when the job execution started.final JobExecutionStatus
status()
The status of the job execution (IN_PROGRESS, QUEUED, FAILED, SUCCEEDED, TIMED_OUT, CANCELED, or REJECTED).final String
The status of the job execution (IN_PROGRESS, QUEUED, FAILED, SUCCEEDED, TIMED_OUT, CANCELED, or REJECTED).A collection of name/value pairs that describe the status of the job execution.final String
thingArn()
The ARN of the thing on which the job execution is running.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final Long
The version of the job execution.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
jobId
The unique identifier you assigned to the job when it was created.
- Returns:
- The unique identifier you assigned to the job when it was created.
-
status
The status of the job execution (IN_PROGRESS, QUEUED, FAILED, SUCCEEDED, TIMED_OUT, CANCELED, or REJECTED).
If the service returns an enum value that is not available in the current SDK version,
status
will returnJobExecutionStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The status of the job execution (IN_PROGRESS, QUEUED, FAILED, SUCCEEDED, TIMED_OUT, CANCELED, or REJECTED).
- See Also:
-
statusAsString
The status of the job execution (IN_PROGRESS, QUEUED, FAILED, SUCCEEDED, TIMED_OUT, CANCELED, or REJECTED).
If the service returns an enum value that is not available in the current SDK version,
status
will returnJobExecutionStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The status of the job execution (IN_PROGRESS, QUEUED, FAILED, SUCCEEDED, TIMED_OUT, CANCELED, or REJECTED).
- See Also:
-
forceCanceled
Will be
true
if the job execution was canceled with the optionalforce
parameter set totrue
.- Returns:
- Will be
true
if the job execution was canceled with the optionalforce
parameter set totrue
.
-
statusDetails
A collection of name/value pairs that describe the status of the job execution.
- Returns:
- A collection of name/value pairs that describe the status of the job execution.
-
thingArn
The ARN of the thing on which the job execution is running.
- Returns:
- The ARN of the thing on which the job execution is running.
-
queuedAt
The time, in seconds since the epoch, when the job execution was queued.
- Returns:
- The time, in seconds since the epoch, when the job execution was queued.
-
startedAt
The time, in seconds since the epoch, when the job execution started.
- Returns:
- The time, in seconds since the epoch, when the job execution started.
-
lastUpdatedAt
The time, in seconds since the epoch, when the job execution was last updated.
- Returns:
- The time, in seconds since the epoch, when the job execution was last updated.
-
executionNumber
A string (consisting of the digits "0" through "9") which identifies this particular job execution on this particular device. It can be used in commands which return or update job execution information.
- Returns:
- A string (consisting of the digits "0" through "9") which identifies this particular job execution on this particular device. It can be used in commands which return or update job execution information.
-
versionNumber
The version of the job execution. Job execution versions are incremented each time they are updated by a device.
- Returns:
- The version of the job execution. Job execution versions are incremented each time they are updated by a device.
-
approximateSecondsBeforeTimedOut
The estimated number of seconds that remain before the job execution status will be changed to
TIMED_OUT
. The timeout interval can be anywhere between 1 minute and 7 days (1 to 10080 minutes). The actual job execution timeout can occur up to 60 seconds later than the estimated duration. This value will not be included if the job execution has reached a terminal status.- Returns:
- The estimated number of seconds that remain before the job execution status will be changed to
TIMED_OUT
. The timeout interval can be anywhere between 1 minute and 7 days (1 to 10080 minutes). The actual job execution timeout can occur up to 60 seconds later than the estimated duration. This value will not be included if the job execution has reached a terminal status.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<JobExecution.Builder,
JobExecution> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
-
sdkFields
-