Enum InstanceStatus

java.lang.Object

java.lang.Enum<InstanceStatus>

co.yellowdog.platform.model.InstanceStatus

All Implemented Interfaces:

Serializable, Comparable<InstanceStatus>, java.lang.constant.Constable

public enum InstanceStatus
extends Enum<InstanceStatus>

Describes the status of a instance.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
PENDING	The instance is in the process of being provisioned, or rebooted.
RUNNING	The instance is running.
STOPPED	The instance has been stopped.
STOPPING	The instance is in the process of being stopped.
TERMINATED	The instance has been terminated and can no longer be used.
TERMINATING	The instance is in the process of being terminated.
UNAVAILABLE	The instance is unavailable due to a process external to YellowDog e.g.
UNKNOWN	The status of the instance is unknown.

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

PENDING

public static final InstanceStatus PENDING

The instance is in the process of being provisioned, or rebooted.

RUNNING

public static final InstanceStatus RUNNING

The instance is running.

STOPPING

public static final InstanceStatus STOPPING

The instance is in the process of being stopped.

STOPPED

public static final InstanceStatus STOPPED

The instance has been stopped.

TERMINATING

public static final InstanceStatus TERMINATING

The instance is in the process of being terminated.

TERMINATED

public static final InstanceStatus TERMINATED

The instance has been terminated and can no longer be used.

UNAVAILABLE

public static final InstanceStatus UNAVAILABLE

The instance is unavailable due to a process external to YellowDog e.g. creating an image or repairing the instance.

UNKNOWN

public static final InstanceStatus UNKNOWN

The status of the instance is unknown. The instance can be restarted to try to recover or terminated.

Method Details

values

public static InstanceStatus[] values()

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

Returns:

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

valueOf

public static InstanceStatus 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

isAlive

public boolean isAlive()