public final class YarnEnvironmentBuilder extends AbstractConfiguredAnnotationBuilder<java.util.Map<java.lang.String,java.lang.String>,YarnEnvironmentConfigurer,YarnEnvironmentBuilder> implements PropertiesConfigurerAware, YarnEnvironmentConfigurer
AnnotationBuilder for Yarn environment.| Constructor and Description |
|---|
YarnEnvironmentBuilder()
Instantiates a new yarn environment builder.
|
| Modifier and Type | Method and Description |
|---|---|
void |
addClasspathEntries(java.util.ArrayList<java.lang.String> classpathEntries)
Adds the classpath entries.
|
void |
configuration(org.apache.hadoop.conf.Configuration configuration)
Sets the yarn configuration.
|
void |
configureProperties(java.util.Properties properties)
Configure
Properties. |
YarnEnvironmentConfigurer |
entry(java.lang.String key,
java.lang.String value)
Specify an environment variable.
|
YarnEnvironmentConfigurer |
includeLocalSystemEnv(boolean includeLocalSystemEnv)
Specify if existing system environment variables should
be included automatically.
|
protected java.util.Map<java.lang.String,java.lang.String> |
performBuild()
Subclasses must implement this method to build the object that is being returned.
|
YarnEnvironmentConfigurer |
propertiesLocation(java.lang.String... locations)
Specify properties locations.
|
void |
setDefaultMapreduceAppClasspath(java.lang.String defaultMapreduceAppClasspath)
Sets the default mr app classpath.
|
void |
setDefaultYarnAppClasspath(java.lang.String defaultYarnAppClasspath)
Sets the default yarn app classpath.
|
void |
setDelimiter(java.lang.String delimiter)
Sets the delimiter.
|
void |
setIncludeBaseDirectory(boolean includeBaseDirectory)
Sets the include base directory.
|
void |
setUseDefaultMapreduceClasspath(boolean useDefaultClasspath)
Sets the default classpath.
|
void |
setUseDefaultYarnClasspath(boolean useDefaultClasspath)
Sets the default classpath.
|
EnvironmentClasspathConfigurer |
withClasspath()
Specify a classpath environment variable.
|
PropertiesConfigurer<YarnEnvironmentConfigurer> |
withProperties()
Specify properties with a
PropertiesConfigurer. |
apply, apply, beforeConfigureMains, beforeConfigurePosts, beforeInit, doBuild, getConfigurer, getConfigurers, getOrApply, getOrBuild, getSharedObject, getSharedObjects, objectPostProcessor, postProcess, removeConfigurer, removeConfigurers, setSharedObjectbuild, getObjectpublic YarnEnvironmentBuilder()
protected java.util.Map<java.lang.String,java.lang.String> performBuild()
throws java.lang.Exception
AbstractConfiguredAnnotationBuilderperformBuild in class AbstractConfiguredAnnotationBuilder<java.util.Map<java.lang.String,java.lang.String>,YarnEnvironmentConfigurer,YarnEnvironmentBuilder>java.lang.Exceptionpublic void configureProperties(java.util.Properties properties)
PropertiesConfigurerAwareProperties.configureProperties in interface PropertiesConfigurerAwareproperties - the propertiespublic EnvironmentClasspathConfigurer withClasspath() throws java.lang.Exception
YarnEnvironmentConfigurer
Applies a new DefaultEnvironmentClasspathConfigurer into current
builder. Equivalents between JavaConfig and XML are shown below.
JavaConfig:
public void configure(YarnEnvironmentBuilder environment) throws Exception {
environment
.withClasspath()
.entry("cpEntry1")
.entry("cpEntry2")
.useDefaultYarnClasspath(true);
}
<yarn:environment>
<yarn:classpath use-yarn-app-classpath="true" delimiter=":">
cpEntry1
cpEntry2
</yarn:classpath>
</yarn:environment>
withClasspath in interface YarnEnvironmentConfigurerDefaultEnvironmentClasspathConfigurer for classpathjava.lang.Exception - if error occurredpublic YarnEnvironmentConfigurer entry(java.lang.String key, java.lang.String value)
YarnEnvironmentConfigurer
public void configure(YarnEnvironmentConfigure environment) throws Exception {
environment
.entry("myKey1","myValue1")
.entry("myKey2","myValue2");
}
<yarn:environment> myKey1=myValue1 myKey2=myValue2 </yarn:environment>
entry in interface YarnEnvironmentConfigurerkey - The environment keyvalue - The environment valueYarnEnvironmentConfigurer for chainingpublic YarnEnvironmentConfigurer propertiesLocation(java.lang.String... locations) throws java.io.IOException
YarnEnvironmentConfigurer
public void configure(YarnEnvironmentConfigure environment) throws Exception {
environment
.entry("myKey1","myValue1")
.entry("myKey2","myValue2")
.propertiesLocation("cfg-1.properties", "cfg-2.properties");
}
<yarn:environment properties-location="cfg-1.properties, cfg-2.properties"> myKey1=myValue1 myKey2=myValue2 </yarn:environment>
propertiesLocation in interface YarnEnvironmentConfigurerlocations - The properties file locationsYarnEnvironmentConfigurer for chainingjava.io.IOException - if error occurredpublic YarnEnvironmentConfigurer includeLocalSystemEnv(boolean includeLocalSystemEnv)
YarnEnvironmentConfigurer
public void configure(YarnEnvironmentConfigure environment) throws Exception {
environment
.includeLocalSystemEnv(false);
}
<yarn:environment include-local-system-env="false"/>
includeLocalSystemEnv in interface YarnEnvironmentConfigurerincludeLocalSystemEnv - if system env variables should be includedYarnEnvironmentConfigurer for chainingpublic PropertiesConfigurer<YarnEnvironmentConfigurer> withProperties() throws java.lang.Exception
YarnEnvironmentConfigurerPropertiesConfigurer.
public void configure(YarnEnvironmentConfigure environment) throws Exception {
Properties props = new Properties();
environment
.withProperties()
.properties(props)
.property("myKey1", ",myValue1")
.and();
}
<util:properties id="props" location="props.properties"/> <prop key="myKey1">myValue1</prop> </util:properties> <yarn:environment properties-ref="props"/>
withProperties in interface YarnEnvironmentConfigurerPropertiesConfigurer for chainingjava.lang.Exception - if error occurredpublic void addClasspathEntries(java.util.ArrayList<java.lang.String> classpathEntries)
classpathEntries - the classpath entriespublic void configuration(org.apache.hadoop.conf.Configuration configuration)
configuration - the yarn configurationpublic void setUseDefaultYarnClasspath(boolean useDefaultClasspath)
useDefaultClasspath - the new default classpathpublic void setUseDefaultMapreduceClasspath(boolean useDefaultClasspath)
useDefaultClasspath - the new default classpathpublic void setIncludeBaseDirectory(boolean includeBaseDirectory)
includeBaseDirectory - the new include base directorypublic void setDelimiter(java.lang.String delimiter)
delimiter - the new delimiterpublic void setDefaultYarnAppClasspath(java.lang.String defaultYarnAppClasspath)
defaultYarnAppClasspath - the new default yarn app classpathpublic void setDefaultMapreduceAppClasspath(java.lang.String defaultMapreduceAppClasspath)
defaultMapreduceAppClasspath - the new default mr app classpath