Package org.apache.hadoop.yarn.api

Enum Class ApplicationConstants.Environment

java.lang.Object
java.lang.Enum<ApplicationConstants.Environment>
org.apache.hadoop.yarn.api.ApplicationConstants.Environment
All Implemented Interfaces:
Serializable, Comparable<ApplicationConstants.Environment>, Constable
Enclosing interface:
ApplicationConstants
public static enum ApplicationConstants.Environment extends Enum<ApplicationConstants.Environment>
Environment for Applications. Some of the environment variables for applications are final i.e. they cannot be modified by the applications.

  • Enum Constant Details

  • Method Details

    • values

      public static ApplicationConstants.Environment[] 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 ApplicationConstants.Environment 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

    • key

      public String key()

    • toString

      public String toString()
      Overrides:
      toString in class Enum<ApplicationConstants.Environment>

    • $

      public String $()
      Expand the environment variable based on client OS environment variable expansion syntax (e.g. $VAR for Linux and %VAR% for Windows).

      Note: Use $$() method for cross-platform practice i.e. submit an application from a Windows client to a Linux/Unix server or vice versa.

      Returns:
      expanded environment variable.

    • $$

      @Public @Unstable public String $$()
      Expand the environment variable in platform-agnostic syntax. The parameter expansion marker "{{VAR}}" will be replaced with real parameter expansion marker ('%' for Windows and '$' for Linux) by NodeManager on container launch. For example: {{VAR}} will be replaced as $VAR on Linux, and %VAR% on Windows.
      Returns:
      expanded environment variable.