org.apache.hadoop.yarn.api.records

Enum LocalResourceVisibility

java.lang.Object

java.lang.Enum<LocalResourceVisibility>

org.apache.hadoop.yarn.api.records.LocalResourceVisibility

All Implemented Interfaces:

Serializable, Comparable<LocalResourceVisibility>

@InterfaceAudience.Public
@InterfaceStability.Stable
public enum LocalResourceVisibility
extends Enum<LocalResourceVisibility>

LocalResourceVisibility specifies the visibility of a resource localized by the NodeManager.

The visibility can be one of:

• PUBLIC - Shared by all users on the node.
• PRIVATE - Shared among all applications of the same user on the node.
• APPLICATION - Shared only among containers of the same application on the node.

See Also:

LocalResource, ContainerLaunchContext, ApplicationSubmissionContext, ContainerManagementProtocol.startContainers(org.apache.hadoop.yarn.api.protocolrecords.StartContainersRequest)

Enum Constant Summary

Enum Constants

Enum Constant and Description
APPLICATION Shared only among containers of the same application on the node.
PRIVATE Shared among all applications of the same user on the node.
PUBLIC Shared by all users on the node.

Method Summary

Methods

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

PUBLIC

public static final LocalResourceVisibility PUBLIC

Shared by all users on the node.

PRIVATE

public static final LocalResourceVisibility PRIVATE

Shared among all applications of the same user on the node.

APPLICATION

public static final LocalResourceVisibility APPLICATION

Shared only among containers of the same application on the node.

Method Detail

values

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

Returns:

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

valueOf

public static LocalResourceVisibility valueOf(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:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null