com.mesosphere.sdk.specification

Enum GoalState

java.lang.Object

java.lang.Enum<GoalState>

com.mesosphere.sdk.specification.GoalState

All Implemented Interfaces:

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

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

The allowed goal states for a Task. These are treated as the desired outcome for executing a given task.

Enum Constant Summary

Enum Constants

Enum Constant and Description
FINISH Running and then exiting successfully.
FINISHED Running only once over the lifetime of a service.
ONCE Running only once over the lifetime of a service.
RUNNING Running continuously.
UNKNOWN ERROR.

Method Summary

Modifier and Type	Method and Description
static GoalState	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static GoalState[]	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

UNKNOWN

public static final GoalState UNKNOWN

ERROR.

RUNNING

public static final GoalState RUNNING

Running continuously. Should be restarted if it exits.

FINISHED

public static final GoalState FINISHED

Running only once over the lifetime of a service. Should not be run again for the duration of this install. (Will be deprecated in favor of ONCE in future releases, which shares the same semantics.

FINISH

public static final GoalState FINISH

Running and then exiting successfully. Should not be restarted upon a successful exit.

ONCE

public static final GoalState ONCE

Running only once over the lifetime of a service. Should not be run again for the duration of this install.

Method Detail

values

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

Returns:

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

valueOf

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