Package org.apache.hadoop.yarn.service.api.records

Enum Class Component.RestartPolicyEnum

java.lang.Object

java.lang.Enum<Component.RestartPolicyEnum>

org.apache.hadoop.yarn.service.api.records.Component.RestartPolicyEnum

All Implemented Interfaces:

Serializable, Comparable<Component.RestartPolicyEnum>, Constable

Enclosing class:

Component

public static enum Component.RestartPolicyEnum
extends Enum<Component.RestartPolicyEnum>

Policy of restart component. Including ALWAYS - Long lived components (Always restart component instance even if instance exit code = 0.); ON_FAILURE (Only restart component instance if instance exit code != 0); NEVER (Do not restart in any cases)

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
ALWAYS
NEVER
ON_FAILURE

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ALWAYS

public static final Component.RestartPolicyEnum ALWAYS

ON_FAILURE

public static final Component.RestartPolicyEnum ON_FAILURE

NEVER

public static final Component.RestartPolicyEnum NEVER

Method Details

values

public static Component.RestartPolicyEnum[] values()

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

Returns:

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

valueOf

public static Component.RestartPolicyEnum valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

toString

public String toString()

Overrides:

toString in class Enum<Component.RestartPolicyEnum>