Package org.apache.hadoop.yarn.util

Class Apps

java.lang.Object

org.apache.hadoop.yarn.util.Apps

@Private
public class Apps
extends java.lang.Object

YARN internal application-related utilities

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	APP
static java.lang.String	ID

Constructor Summary

Constructors

Constructor	Description
Apps()

Method Summary

Modifier and Type	Method	Description
static void	addToEnvironment(java.util.Map<java.lang.String,java.lang.String> environment, java.lang.String variable, java.lang.String value)	Deprecated.
static void	addToEnvironment(java.util.Map<java.lang.String,java.lang.String> environment, java.lang.String variable, java.lang.String value, java.lang.String classPathSeparator)
static java.lang.String	crossPlatformify(java.lang.String var)
static java.util.Set<java.lang.String>	getEnvVarsFromInputProperty(java.lang.String propName, java.lang.String defaultPropValue, org.apache.hadoop.conf.Configuration conf)	Return the list of environment variable names specified in the given property or default string and those specified individually with the propname.VARNAME syntax (e.g., mapreduce.map.env.VARNAME=value).
static boolean	isApplicationFinalState(org.apache.hadoop.yarn.api.records.YarnApplicationState appState)	Returns whether a given application state is final: FINISHED, FAILED or KILLED.
static void	setEnvFromInputProperty(java.util.Map<java.lang.String,java.lang.String> env, java.lang.String propName, java.lang.String defaultPropValue, org.apache.hadoop.conf.Configuration conf, java.lang.String classPathSeparator)	Set environment variables from the given environment input property.
static void	setEnvFromInputString(java.util.Map<java.lang.String,java.lang.String> env, java.lang.String envString)	Deprecated.
static void	setEnvFromInputString(java.util.Map<java.lang.String,java.lang.String> env, java.lang.String envString, java.lang.String classPathSeparator)
static boolean	shouldCountTowardsNodeBlacklisting(int exitStatus)
static void	shouldHaveNext(java.lang.String prefix, java.lang.String s, java.util.Iterator<java.lang.String> it)
static void	throwParseException(java.lang.String name, java.lang.String s)
static org.apache.hadoop.yarn.api.records.ApplicationId	toAppID(java.lang.String aid)
static org.apache.hadoop.yarn.api.records.ApplicationId	toAppID(java.lang.String prefix, java.lang.String s, java.util.Iterator<java.lang.String> it)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

APP

public static final java.lang.String APP

See Also:

Constant Field Values

ID

public static final java.lang.String ID

See Also:

Constant Field Values

Constructor Detail

Apps

public Apps()

Method Detail

toAppID

public static org.apache.hadoop.yarn.api.records.ApplicationId toAppID(java.lang.String aid)

toAppID

public static org.apache.hadoop.yarn.api.records.ApplicationId toAppID(java.lang.String prefix,
                                                                       java.lang.String s,
                                                                       java.util.Iterator<java.lang.String> it)

shouldHaveNext

public static void shouldHaveNext(java.lang.String prefix,
                                  java.lang.String s,
                                  java.util.Iterator<java.lang.String> it)

throwParseException

public static void throwParseException(java.lang.String name,
                                       java.lang.String s)

setEnvFromInputString

public static void setEnvFromInputString(java.util.Map<java.lang.String,java.lang.String> env,
                                         java.lang.String envString,
                                         java.lang.String classPathSeparator)

setEnvFromInputProperty

public static void setEnvFromInputProperty(java.util.Map<java.lang.String,java.lang.String> env,
                                           java.lang.String propName,
                                           java.lang.String defaultPropValue,
                                           org.apache.hadoop.conf.Configuration conf,
                                           java.lang.String classPathSeparator)

Set environment variables from the given environment input property. For example, given the property mapreduce.map.env, this method will extract environment variables from: the comma-separated string value of mapreduce.map.env, and the values of any properties of the form mapreduce.map.env.VAR_NAME Variables specified via the latter syntax take precedence over those specified using the former syntax.

Parameters:

env - the environment to update

propName - the name of the property

defaultPropValue - the default value for propName

conf - configuration containing properties

classPathSeparator - Separator used when appending to an existing var

getEnvVarsFromInputProperty

public static java.util.Set<java.lang.String> getEnvVarsFromInputProperty(java.lang.String propName,
                                                                          java.lang.String defaultPropValue,
                                                                          org.apache.hadoop.conf.Configuration conf)

Return the list of environment variable names specified in the given property or default string and those specified individually with the propname.VARNAME syntax (e.g., mapreduce.map.env.VARNAME=value).

Parameters:

propName - the name of the property

defaultPropValue - the default value for propName

conf - configuration containing properties

Returns:

Set of environment variable names

setEnvFromInputString

@Deprecated
public static void setEnvFromInputString(java.util.Map<java.lang.String,java.lang.String> env,
                                         java.lang.String envString)

Deprecated.

This older version of this method is kept around for compatibility because downstream frameworks like Spark and Tez have been using it. Downstream frameworks are expected to move off of it.

Parameters:

env - the environment to update.

envString - String containing env variable definitions.

addToEnvironment

@Public
@Unstable
public static void addToEnvironment(java.util.Map<java.lang.String,java.lang.String> environment,
                                    java.lang.String variable,
                                    java.lang.String value,
                                    java.lang.String classPathSeparator)

addToEnvironment

@Deprecated
public static void addToEnvironment(java.util.Map<java.lang.String,java.lang.String> environment,
                                    java.lang.String variable,
                                    java.lang.String value)

Deprecated.

This older version of this method is kept around for compatibility because downstream frameworks like Spark and Tez have been using it. Downstream frameworks are expected to move off of it.

Parameters:

environment - map of environment variable.

variable - variable.

value - value.

crossPlatformify

public static java.lang.String crossPlatformify(java.lang.String var)

shouldCountTowardsNodeBlacklisting

@Private
@Unstable
public static boolean shouldCountTowardsNodeBlacklisting(int exitStatus)

isApplicationFinalState

public static boolean isApplicationFinalState(org.apache.hadoop.yarn.api.records.YarnApplicationState appState)

Returns whether a given application state is final: FINISHED, FAILED or KILLED.

Parameters:

appState - application state

Returns:

whether the appState is final.