org.springframework.yarn.config.annotation.builders

Interface YarnContainerConfigurer

All Known Implementing Classes:

YarnContainerBuilder

public interface YarnContainerConfigurer

YarnContainerConfigure is an interface for YarnContainerBuilder which is exposed to user via SpringYarnConfigurerAdapter.

Typically configuration is shown below.

 @Configuration
 @EnableYarn(enable=Enable.CONTAINER)
 static class Config extends SpringYarnConfigurerAdapter {

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

 }
 

Author:

Janne Valkealahti

Method Summary

Methods

Modifier and Type	Method and Description
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.

Method Detail

containerClass

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

Specify a YarnContainer class.

JavaConfig:

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

XML:

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

Parameters:

clazz - The Yarn container class

Returns:

YarnContainerConfigurer for chaining

containerClass

YarnContainerConfigurer containerClass(java.lang.String clazz)

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

Parameters:

clazz - The Yarn container class

Returns:

YarnContainerConfigurer for chaining

containerRef

YarnContainerConfigurer containerRef(YarnContainer ref)

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"/>
 

Parameters:

ref - The Yarn container reference

Returns:

YarnContainerConfigurer for chaining