Package org.apache.hadoop.yarn.api.protocolrecords

Enum ApplicationsRequestScope

java.lang.Object

java.lang.Enum<ApplicationsRequestScope>

org.apache.hadoop.yarn.api.protocolrecords.ApplicationsRequestScope

All Implemented Interfaces:

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

@Public
@Unstable
public enum ApplicationsRequestScope
extends java.lang.Enum<ApplicationsRequestScope>

Enumeration that controls the scope of applications fetched

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALL	All jobs
OWN	Jobs owned by current user
VIEWABLE	Jobs viewable by current user

Method Summary

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

ALL

public static final ApplicationsRequestScope ALL

All jobs

VIEWABLE

public static final ApplicationsRequestScope VIEWABLE

Jobs viewable by current user

OWN

public static final ApplicationsRequestScope OWN

Jobs owned by current user

Method Detail

values

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

Returns:

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

valueOf

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