Package com.atlassian.bamboo

Enum NodeLifecycleState

java.lang.Object

java.lang.Enum<NodeLifecycleState>

com.atlassian.bamboo.NodeLifecycleState

All Implemented Interfaces:

Serializable, Comparable<NodeLifecycleState>

@PublicApi
public enum NodeLifecycleState
extends Enum<NodeLifecycleState>

Represents the node life cycle

Since:

9.5

Enum Constant Summary

Enum Constants

Enum Constant	Description
PAUSED	The node is paused.
PAUSING	The node is transitioning to PAUSED.
PREPARING_FOR_RESTART	The node is in transitioning to READY_FOR_RESTART state.
READY_FOR_RESTART	The node is paused and ready to be restarted.
RUNNING	The node is running as the primary node.
RUNNING_AS_SECONDARY	The node is running as secondary node.
SETUP	The system is undergoing setup
STARTING	The node is starting

Method Summary

Modifier and Type	Method	Description
Optional<ClusterLifecycleState>	getCorrespondingClusterState()
static NodeLifecycleState	valueOf(String name)	Returns the enum constant of this type with the specified name.
static NodeLifecycleState[]	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, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SETUP

public static final NodeLifecycleState SETUP

The system is undergoing setup

STARTING

public static final NodeLifecycleState STARTING

The node is starting

RUNNING

public static final NodeLifecycleState RUNNING

The node is running as the primary node.

RUNNING_AS_SECONDARY

public static final NodeLifecycleState RUNNING_AS_SECONDARY

The node is running as secondary node.

PAUSING

public static final NodeLifecycleState PAUSING

The node is transitioning to PAUSED. No builds can be queued at this time.

PAUSED

public static final NodeLifecycleState PAUSED

The node is paused. No builds are queued or building.

PREPARING_FOR_RESTART

public static final NodeLifecycleState PREPARING_FOR_RESTART

The node is in transitioning to READY_FOR_RESTART state.

READY_FOR_RESTART

public static final NodeLifecycleState READY_FOR_RESTART

The node is paused and ready to be restarted.

Method Detail

values

public static NodeLifecycleState[] 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 (NodeLifecycleState c : NodeLifecycleState.values())
    System.out.println(c);

Returns:

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

valueOf

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

getCorrespondingClusterState

public Optional<ClusterLifecycleState> getCorrespondingClusterState()