JobExecution (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.services.iot.model.JobExecution

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<JobExecution.Builder,JobExecution>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class JobExecution
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<JobExecution.Builder,JobExecution>
```
The job execution object represents the execution of a job on a particular device.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface JobExecution.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`JobExecution.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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)`
`boolean`	`equalsBySdkFields(Object obj)`
`Long`	`executionNumber()` A string (consisting of the digits "0" through "9") which identifies this particular job execution on this particular device.
`Boolean`	`forceCanceled()` Will be `true` if the job execution was canceled with the optional `force` parameter set to `true`.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`String`	`jobId()` The unique identifier you assigned to the job when it was created.
`Instant`	`lastUpdatedAt()` The time, in seconds since the epoch, when the job execution was last updated.
`Instant`	`queuedAt()` The time, in seconds since the epoch, when the job execution was queued.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends JobExecution.Builder>`	`serializableBuilderClass()`
`Instant`	`startedAt()` The time, in seconds since the epoch, when the job execution started.
`JobExecutionStatus`	`status()` The status of the job execution (IN_PROGRESS, QUEUED, FAILED, SUCCEEDED, TIMED_OUT, CANCELED, or REJECTED).
`String`	`statusAsString()` The status of the job execution (IN_PROGRESS, QUEUED, FAILED, SUCCEEDED, TIMED_OUT, CANCELED, or REJECTED).
`JobExecutionStatusDetails`	`statusDetails()` A collection of name/value pairs that describe the status of the job execution.
`String`	`thingArn()` The ARN of the thing on which the job execution is running.
`JobExecution.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`Long`	`versionNumber()` The version of the job execution.

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - jobId
```
public final String 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
```
public final JobExecutionStatus 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 return JobExecutionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    
    Returns:
    
    The status of the job execution (IN_PROGRESS, QUEUED, FAILED, SUCCEEDED, TIMED_OUT, CANCELED, or REJECTED).
    
    See Also:
    
    JobExecutionStatus
  - statusAsString
```
public final String 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 return JobExecutionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    
    Returns:
    
    The status of the job execution (IN_PROGRESS, QUEUED, FAILED, SUCCEEDED, TIMED_OUT, CANCELED, or REJECTED).
    
    See Also:
    
    JobExecutionStatus
  - forceCanceled
```
public final Boolean forceCanceled()
```
    Will be true if the job execution was canceled with the optional force parameter set to true.
    
    Returns:
    
    Will be true if the job execution was canceled with the optional force parameter set to true.
  - statusDetails
```
public final JobExecutionStatusDetails 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
```
public final String 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
```
public final Instant 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
```
public final Instant 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
```
public final Instant 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
```
public final Long 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
```
public final Long 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
```
public final Long 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
```
public JobExecution.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<JobExecution.Builder,JobExecution>
  - builder
```
public static JobExecution.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends JobExecution.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String 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.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class JobExecution

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

jobId

status

statusAsString

forceCanceled

statusDetails

thingArn

queuedAt

startedAt

lastUpdatedAt

executionNumber

versionNumber

approximateSecondsBeforeTimedOut

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields