software.amazon.awssdk.services.iotjobsdataplane.model

Class JobExecutionState

java.lang.Object

software.amazon.awssdk.services.iotjobsdataplane.model.JobExecutionState

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<JobExecutionState.Builder,JobExecutionState>

@Generated(value="software.amazon.awssdk:codegen")
public final class JobExecutionState
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<JobExecutionState.Builder,JobExecutionState>

Contains data about the state of a job execution.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	JobExecutionState.Builder

Method Summary

Modifier and Type	Method and Description
static JobExecutionState.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasStatusDetails() For responses, this returns true if the service returned a value for the StatusDetails property.
List<SdkField<?>>	sdkFields()
static Class<? extends JobExecutionState.Builder>	serializableBuilderClass()
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.
JobExecutionState.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

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()

For responses, this returns true if the service returned a value for the StatusDetails property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

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.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasStatusDetails() method.

Returns:

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

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.

toBuilder

public JobExecutionState.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<JobExecutionState.Builder,JobExecutionState>

builder

public static JobExecutionState.Builder builder()

serializableBuilderClass

public static Class<? extends JobExecutionState.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