com.mesosphere.sdk.scheduler.plan

Enum Status

java.lang.Object

java.lang.Enum<Status>

com.mesosphere.sdk.scheduler.plan.Status

All Implemented Interfaces:

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

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

Status of an Element. The Status indicates to PlanManagers how to handle Plan elements. For a Step the normal progression of states is: PENDING --> PREPARED --> STARTING --> COMPLETE When something goes wrong, and a retry is desirable returning to PENDING from PREPARED or STARTING indicates that an Element should be restarted. COMPLETE is a terminal state which should not be changed, once it is reached for any given processing of an Element. The ERROR state indicates that the initial construction of the Element failed. This normally occurs when an invalidation configuration is attempted. For example, changing the disk size specification in a TaskSpec is generally not a legal operation so attempting to create a Step Element to accomplish this work would result in a Step with an ERROR state. The WAITING is a special state only used to show propagating effect of interrupted elements. It indicates that either current Element is interrupted or at least one of its children is interrupted. It is only returned by PlanUtils.getStatus(). Status will never set to WAITING and should never be comparing whether it is WAITING or not. Internally, interrupt is a separate state, and isInterrupted() call is used to check whether an Element is interrupted or not.

Enum Constant Summary

Enum Constants

Enum Constant and Description
COMPLETE Execution has completed.
ERROR Execution experienced an error.
IN_PROGRESS Only returned by Phase and Plan getStatus, to state that at least one child is complete and at least one child is in progress (either PENDING or PREPARED).
PENDING Execution is waiting for suitable offers.
PREPARED The Element has been evaluated, and any Tasks relevant to it have been killed if necessary.
STARTED Execution has performed org.apache.mesos.Protos.Offer.Operations and has received feedback, but not all success requiremens (e.g.
STARTING Execution has performed org.apache.mesos.Protos.Offer.Operations and is waiting to determine the success of those Operations.
WAITING Execution has been interrupted.

Method Summary

Modifier and Type	Method and Description
boolean	isRunning() Status is in one of the running states.
static Status	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Status[]	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

ERROR

public static final Status ERROR

Execution experienced an error.

WAITING

public static final Status WAITING

Execution has been interrupted. This value is only returned by PlanUtils.getStatus. Status is NEVER set to WAITING. Do not compare whether it is WAITING or not. Use isInterrupted() call, interrupt is a separate state internally.

PENDING

public static final Status PENDING

Execution is waiting for suitable offers.

PREPARED

public static final Status PREPARED

The Element has been evaluated, and any Tasks relevant to it have been killed if necessary.

STARTING

public static final Status STARTING

Execution has performed org.apache.mesos.Protos.Offer.Operations and is waiting to determine the success of those Operations.

STARTED

public static final Status STARTED

Execution has performed org.apache.mesos.Protos.Offer.Operations and has received feedback, but not all success requiremens (e.g. readiness checks) have been satisfied.

COMPLETE

public static final Status COMPLETE

Execution has completed.

IN_PROGRESS

public static final Status IN_PROGRESS

Only returned by Phase and Plan getStatus, to state that at least one child is complete and at least one child is in progress (either PENDING or PREPARED). This value is only returned and never set to a variable.

Method Detail

values

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

Returns:

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

valueOf

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

isRunning

public boolean isRunning()

Status is in one of the running states.