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

Enum QueueState

java.lang.Object

java.lang.Enum<QueueState>

org.apache.hadoop.yarn.api.records.QueueState

All Implemented Interfaces:

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

@Public
@Stable
public enum QueueState
extends java.lang.Enum<QueueState>

State of a Queue.

A queue is in one of:

• RUNNING - normal state.
• STOPPED - not accepting new application submissions.
• DRAINING - not accepting new application submissions and waiting for applications finish.

See Also:

QueueInfo, ApplicationClientProtocol.getQueueInfo(org.apache.hadoop.yarn.api.protocolrecords.GetQueueInfoRequest)

Enum Constant Summary

Enum Constants

Enum Constant	Description
DRAINING	Draining - Not accepting submissions of new applications, and waiting for applications finish.
RUNNING	Running - normal operation.
STOPPED	Stopped - Not accepting submissions of new applications.

Method Summary

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

STOPPED

public static final QueueState STOPPED

Stopped - Not accepting submissions of new applications.

DRAINING

public static final QueueState DRAINING

Draining - Not accepting submissions of new applications, and waiting for applications finish.

RUNNING

public static final QueueState RUNNING

Running - normal operation.

Method Detail

values

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

Returns:

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

valueOf

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