software.amazon.awssdk.services.iotjobsdataplane.model

Class JobExecution

java.lang.Object

software.amazon.awssdk.services.iotjobsdataplane.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>

Contains data about a job execution.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	JobExecution.Builder

Method Summary

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 number that identifies a particular job execution on a particular device.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasStatusDetails() Returns true if the StatusDetails property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
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()
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 this job when it was created.

Returns:

The unique identifier you assigned to this job when it was created.

thingName

public final String thingName()

The name of the thing that is executing the job.

Returns:

The name of the thing that is executing the job.

status

public final 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().

Returns:

The status of the job execution. Can be one of: "QUEUED", "IN_PROGRESS", "FAILED", "SUCCESS", "CANCELED", "REJECTED", or "REMOVED".

See Also:

JobExecutionStatus

statusAsString

public final 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().

Returns:

The status of the job execution. Can be one of: "QUEUED", "IN_PROGRESS", "FAILED", "SUCCESS", "CANCELED", "REJECTED", or "REMOVED".

See Also:

JobExecutionStatus

hasStatusDetails

public final boolean hasStatusDetails()

Returns true if the StatusDetails property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

statusDetails

public final 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.

You can use hasStatusDetails() to see if a value was sent in this field.

Returns:

A collection of name/value pairs that describe the status of the job execution.

queuedAt

public final Long queuedAt()

The time, in milliseconds since the epoch, when the job execution was enqueued.

Returns:

The time, in milliseconds since the epoch, when the job execution was enqueued.

startedAt

public final Long startedAt()

The time, in milliseconds since the epoch, when the job execution was started.

Returns:

The time, in milliseconds since the epoch, when the job execution was started.

lastUpdatedAt

public final Long lastUpdatedAt()

The time, in milliseconds since the epoch, when the job execution was last updated.

Returns:

The time, in milliseconds since the epoch, when the job execution was last updated.

approximateSecondsBeforeTimedOut

public final Long approximateSecondsBeforeTimedOut()

The estimated number of seconds that remain before the job execution status will be changed to TIMED_OUT.

Returns:

The estimated number of seconds that remain before the job execution status will be changed to TIMED_OUT.

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.

executionNumber

public final 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.

Returns:

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.

jobDocument

public final String jobDocument()

The content of the job document.

Returns:

The content of the job document.

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