Enum Class RemoteExecutionStatus

java.lang.Object

java.lang.Enum<RemoteExecutionStatus>

io.gem.api.RemoteExecutionStatus

All Implemented Interfaces:

Serializable, Comparable<RemoteExecutionStatus>, Constable

public enum RemoteExecutionStatus
extends Enum<RemoteExecutionStatus>

Terminal outcome of an SBK command submitted to one remote host.

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CANCELLED	The command was cancelled because another node failed.
EXIT_FAILURE	The remote command completed with a non-zero exit code.
NOT_COMPLETED	No terminal result was obtained for the configured host.
SSH_ERROR	The SSH transport failed before a usable exit code was received.
SUCCESS	The remote command completed with exit code zero.
TIMEOUT	The remote command exceeded its execution deadline.

Method Summary

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

Methods inherited from class Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

SUCCESS

public static final RemoteExecutionStatus SUCCESS

The remote command completed with exit code zero.

EXIT_FAILURE

public static final RemoteExecutionStatus EXIT_FAILURE

The remote command completed with a non-zero exit code.

SSH_ERROR

public static final RemoteExecutionStatus SSH_ERROR

The SSH transport failed before a usable exit code was received.

TIMEOUT

public static final RemoteExecutionStatus TIMEOUT

The remote command exceeded its execution deadline.

CANCELLED

public static final RemoteExecutionStatus CANCELLED

The command was cancelled because another node failed.

NOT_COMPLETED

public static final RemoteExecutionStatus NOT_COMPLETED

No terminal result was obtained for the configured host.

Method Details

values

public static RemoteExecutionStatus[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static RemoteExecutionStatus valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null