org.springframework.yarn.config.annotation.builders
Class YarnResourceLocalizerBuilder

java.lang.Object
  extended by org.springframework.data.hadoop.config.common.annotation.AbstractAnnotationBuilder<O>
      extended by org.springframework.data.hadoop.config.common.annotation.AbstractConfiguredAnnotationBuilder<ResourceLocalizer,YarnResourceLocalizerConfigurer,YarnResourceLocalizerBuilder>
          extended by org.springframework.yarn.config.annotation.builders.YarnResourceLocalizerBuilder
All Implemented Interfaces:
org.springframework.data.hadoop.config.common.annotation.AnnotationBuilder<ResourceLocalizer>, YarnResourceLocalizerConfigurer

public final class YarnResourceLocalizerBuilder
extends org.springframework.data.hadoop.config.common.annotation.AbstractConfiguredAnnotationBuilder<ResourceLocalizer,YarnResourceLocalizerConfigurer,YarnResourceLocalizerBuilder>
implements YarnResourceLocalizerConfigurer

AnnotationBuilder for ResourceLocalizer.

Author:
Janne Valkealahti

Constructor Summary
YarnResourceLocalizerBuilder()
           
 
Method Summary
 void configuration(Configuration configuration)
           
 YarnResourceLocalizerBuilder defaultLocalResourceType(LocalResourceType type)
           
 YarnResourceLocalizerBuilder defaultLocalResourceVisibility(LocalResourceVisibility visibility)
           
protected  ResourceLocalizer performBuild()
           
 void setCopyEntries(Collection<LocalResourcesFactoryBean.CopyEntry> copyEntries)
           
 void setHdfsEntries(Collection<LocalResourcesFactoryBean.TransferEntry> transferEntries)
           
 void setRawCopyEntries(Collection<LocalResourcesFactoryBean.RawCopyEntry> rawEntries)
           
 DefaultLocalResourcesCopyConfigurer withCopy()
          Specify configuration options as properties with a DefaultLocalResourcesCopyConfigurer.
 DefaultLocalResourcesHdfsConfigurer withHdfs()
          Specify configuration options as properties with a DefaultLocalResourcesCopyConfigurer.
 
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

YarnResourceLocalizerBuilder

public YarnResourceLocalizerBuilder()
Method Detail

performBuild

protected ResourceLocalizer performBuild()
                                  throws Exception
Specified by:
performBuild in class org.springframework.data.hadoop.config.common.annotation.AbstractConfiguredAnnotationBuilder<ResourceLocalizer,YarnResourceLocalizerConfigurer,YarnResourceLocalizerBuilder>
Throws:
Exception

configuration

public void configuration(Configuration configuration)

defaultLocalResourceType

public YarnResourceLocalizerBuilder defaultLocalResourceType(LocalResourceType type)

defaultLocalResourceVisibility

public YarnResourceLocalizerBuilder defaultLocalResourceVisibility(LocalResourceVisibility visibility)

setCopyEntries

public void setCopyEntries(Collection<LocalResourcesFactoryBean.CopyEntry> copyEntries)

setHdfsEntries

public void setHdfsEntries(Collection<LocalResourcesFactoryBean.TransferEntry> transferEntries)

setRawCopyEntries

public void setRawCopyEntries(Collection<LocalResourcesFactoryBean.RawCopyEntry> rawEntries)

withCopy

public DefaultLocalResourcesCopyConfigurer withCopy()
                                             throws Exception
Description copied from interface: YarnResourceLocalizerConfigurer
Specify configuration options as properties with a DefaultLocalResourcesCopyConfigurer.

JavaConfig:

 public void configure(YarnResourceLocalizerConfigure localizer) throws Exception {
   localizer
     .withCopy()
       .copy("foo.jar", "/tmp", true);
 }
 

XML:

 <yarn:localresources>
   <:hdfs path="/tmp/foo.jar" staging="false"/>
 </yarn:localresources>
 

Specified by:
withCopy in interface YarnResourceLocalizerConfigurer
Returns:
LocalResourcesCopyConfigurer for chaining
Throws:
Exception - if error occurred

withHdfs

public DefaultLocalResourcesHdfsConfigurer withHdfs()
                                             throws Exception
Description copied from interface: YarnResourceLocalizerConfigurer
Specify configuration options as properties with a DefaultLocalResourcesCopyConfigurer.

JavaConfig:

 public void configure(YarnResourceLocalizerConfigure localizer) throws Exception {
   localizer
     .withHdfs()
       .hdfs("/tmp/foo.jar");
 }
 

XML:

 <yarn:localresources>
   <:hdfs path="/tmp/foo.jar" staging="false"/>
 </yarn:localresources>
 

Specified by:
withHdfs in interface YarnResourceLocalizerConfigurer
Returns:
LocalResourcesCopyConfigurer for chaining
Throws:
Exception - if error occurred