org.springframework.yarn.config.annotation.builders

Class YarnContainerBuilder

java.lang.Object

org.springframework.data.hadoop.config.common.annotation.AbstractAnnotationBuilder<O>

org.springframework.data.hadoop.config.common.annotation.AbstractConfiguredAnnotationBuilder<YarnContainer,YarnContainerConfigurer,YarnContainerBuilder>

org.springframework.yarn.config.annotation.builders.YarnContainerBuilder

All Implemented Interfaces:

AnnotationBuilder<YarnContainer>, YarnContainerConfigurer

public class YarnContainerBuilder
extends AbstractConfiguredAnnotationBuilder<YarnContainer,YarnContainerConfigurer,YarnContainerBuilder>
implements YarnContainerConfigurer

Constructor Summary

Constructors

Constructor and Description
YarnContainerBuilder()

Method Summary

Methods

Modifier and Type	Method and Description
void	configuration(org.apache.hadoop.conf.Configuration configuration)
YarnContainerConfigurer	containerClass(java.lang.Class<? extends YarnContainer> clazz) Specify a YarnContainer class.
YarnContainerConfigurer	containerClass(java.lang.String clazz) Specify a YarnContainer as a fully qualified class name.
YarnContainerConfigurer	containerRef(YarnContainer ref) Specify a YarnContainer reference.
protected YarnContainer	performBuild() Subclasses must implement this method to build the object that is being returned.

Methods inherited from class org.springframework.data.hadoop.config.common.annotation.AbstractConfiguredAnnotationBuilder

apply, apply, beforeConfigureMains, beforeConfigurePosts, beforeInit, doBuild, getConfigurer, getConfigurers, getOrApply, getOrBuild, getSharedObject, getSharedObjects, objectPostProcessor, postProcess, removeConfigurer, removeConfigurers, setSharedObject

Methods inherited from class org.springframework.data.hadoop.config.common.annotation.AbstractAnnotationBuilder

build, getObject

Methods inherited from class java.lang.Object

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

Constructor Detail

YarnContainerBuilder

public YarnContainerBuilder()

Method Detail

performBuild

protected YarnContainer performBuild()
                              throws java.lang.Exception

Description copied from class: AbstractConfiguredAnnotationBuilder

Subclasses must implement this method to build the object that is being returned.

Specified by:

performBuild in class AbstractConfiguredAnnotationBuilder<YarnContainer,YarnContainerConfigurer,YarnContainerBuilder>

Returns:

Object build by this builder

Throws:

java.lang.Exception - on error

containerClass

public YarnContainerConfigurer containerClass(java.lang.Class<? extends YarnContainer> clazz)

Description copied from interface: YarnContainerConfigurer

Specify a YarnContainer class.

JavaConfig:

 public void configure(YarnContainerConfigure container) throws Exception {
   container
     .containerClass(MyYarnContainer.class);
 }
 

XML:

 <yarn:container container-class="com.example.MyYarnContainer"/>
 

Specified by:

containerClass in interface YarnContainerConfigurer

Parameters:

clazz - The Yarn container class

Returns:

YarnContainerConfigurer for chaining

containerClass

public YarnContainerConfigurer containerClass(java.lang.String clazz)

Description copied from interface: YarnContainerConfigurer

Specify a YarnContainer as a fully qualified class name.

JavaConfig:

 public void configure(YarnContainerConfigure container) throws Exception {
   container
     .containerClass("foo.example.MyYarnContainer");
 }
 

XML:
No equivalent

Specified by:

containerClass in interface YarnContainerConfigurer

Parameters:

clazz - The Yarn container class

Returns:

YarnContainerConfigurer for chaining

configuration

public void configuration(org.apache.hadoop.conf.Configuration configuration)

containerRef

public YarnContainerConfigurer containerRef(YarnContainer ref)

Description copied from interface: YarnContainerConfigurer

Specify a YarnContainer reference.

JavaConfig:

 @Autowired
 private YarnContainer yarnContainer;

 public void configure(YarnContainerConfigure container) throws Exception {
   container
     .containerRef(MyYarnContainer.class);
 }
 

XML:

 <bean id="myYarnContainer" class="com.example.MyYarnContainer"/>
 <yarn:container container-ref="myYarnContainer"/>
 

Specified by:

containerRef in interface YarnContainerConfigurer

Parameters:

ref - The Yarn container reference

Returns:

YarnContainerConfigurer for chaining