com.mesosphere.sdk.state

Enum GoalStateOverride

java.lang.Object

java.lang.Enum<GoalStateOverride>

com.mesosphere.sdk.state.GoalStateOverride

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<GoalStateOverride>

public enum GoalStateOverride
extends java.lang.Enum<GoalStateOverride>

The definition of a goal state override for a task. These are custom states, other than GoalStates, which a task may enter. The main difference between this and GoalState is that GoalStates are configured by the service developer, whereas GoalStateOverrides are applied by the operator.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GoalStateOverride.Progress The state of the override itself.
static class	GoalStateOverride.Status Describes the current state of an override.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DECOMMISSIONED The definition of the "DECOMMISSIONED" override state, where tasks are removed from the service.
NONE The definition of the default no-override state.
PAUSED The definition of the "PAUSED" override state, where commands are replaced with sleep()s.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PAUSE_COMMAND Sleep forever when pausing.
static java.lang.String	PAUSE_READINESS_COMMAND Plans should not assume that a paused task has fulfilled the requirement of its dependencies.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getSerializedName() The label which tasks in this state are given.
java.lang.String	getTransitioningName() The state which tasks which are in the process of entering this state are given.
GoalStateOverride.Status	newStatus(GoalStateOverride.Progress progress)
static GoalStateOverride	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static GoalStateOverride[]	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

NONE

public static final GoalStateOverride NONE

The definition of the default no-override state. Refer to the task's GoalState setting.

PAUSED

public static final GoalStateOverride PAUSED

The definition of the "PAUSED" override state, where commands are replaced with sleep()s.

DECOMMISSIONED

public static final GoalStateOverride DECOMMISSIONED

The definition of the "DECOMMISSIONED" override state, where tasks are removed from the service.

Field Detail

PAUSE_COMMAND

public static final java.lang.String PAUSE_COMMAND

Sleep forever when pausing.

PAUSE_READINESS_COMMAND

public static final java.lang.String PAUSE_READINESS_COMMAND

Plans should not assume that a paused task has fulfilled the requirement of its dependencies. Returnging an always failing readinness check guarantees that plan execution does not interpret a paused task as being ready.

See Also:

Constant Field Values

Method Detail

values

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

Returns:

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

valueOf

public static GoalStateOverride valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null

newStatus

public GoalStateOverride.Status newStatus(GoalStateOverride.Progress progress)

getSerializedName

public java.lang.String getSerializedName()

The label which tasks in this state are given. For example "RUNNING" or "PAUSED". This is shown to users and stored in task state storage.

WARNING: THIS IS STORED IN ZOOKEEPER TASK METADATA AND THEREFORE CANNOT EASILY BE CHANGED

getTransitioningName

public java.lang.String getTransitioningName()

The state which tasks which are in the process of entering this state are given. For example "STARTING" or "PAUSING". This is shown to users but not stored anywhere.