Package software.amazon.awssdk.iot.iotcommands.model

Enum CommandExecutionStatus

java.lang.Object

java.lang.Enum<CommandExecutionStatus>

software.amazon.awssdk.iot.iotcommands.model.CommandExecutionStatus

All Implemented Interfaces:

Serializable, Comparable<CommandExecutionStatus>

public enum CommandExecutionStatus
extends Enum<CommandExecutionStatus>

The status of the command execution.

Enum Constant Summary

Enum Constants

Enum Constant	Description
FAILED	The device failed to complete the command.
IN_PROGRESS	The device is currently processing the received command.
REJECTED	The device received an invalid or incomplete request.
SUCCEEDED	The device successfully completed the command.
TIMED_OUT	When the command execution timed out, this status can be used to provide additional information in the statusReason field in the UpdateCommandExecutionRequest request.
UNKNOWN_ENUM_VALUE	Enum value is an unknown value

Method Summary

Modifier and Type	Method	Description
String	toString()
static CommandExecutionStatus	valueOf(String name)	Returns the enum constant of this type with the specified name.
static CommandExecutionStatus[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

UNKNOWN_ENUM_VALUE

public static final CommandExecutionStatus UNKNOWN_ENUM_VALUE

Enum value is an unknown value

IN_PROGRESS

public static final CommandExecutionStatus IN_PROGRESS

The device is currently processing the received command.

SUCCEEDED

public static final CommandExecutionStatus SUCCEEDED

The device successfully completed the command.

FAILED

public static final CommandExecutionStatus FAILED

The device failed to complete the command.

REJECTED

public static final CommandExecutionStatus REJECTED

The device received an invalid or incomplete request.

TIMED_OUT

public static final CommandExecutionStatus TIMED_OUT

When the command execution timed out, this status can be used to provide additional information in the statusReason field in the UpdateCommandExecutionRequest request.

Method Detail

values

public static CommandExecutionStatus[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (CommandExecutionStatus c : CommandExecutionStatus.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static CommandExecutionStatus valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

toString

public String toString()

Overrides:

toString in class Enum<CommandExecutionStatus>