org.springframework.yarn.config.annotation.builders

Class YarnResourceLocalizerBuilder

java.lang.Object

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

org.springframework.data.hadoop.config.common.annotation.AbstractConfiguredAnnotationBuilder<ResourceLocalizer,YarnResourceLocalizerConfigurer,YarnResourceLocalizerBuilder>

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

All Implemented Interfaces:

AnnotationBuilder<ResourceLocalizer>, YarnResourceLocalizerConfigurer

public final class YarnResourceLocalizerBuilder
extends AbstractConfiguredAnnotationBuilder<ResourceLocalizer,YarnResourceLocalizerConfigurer,YarnResourceLocalizerBuilder>
implements YarnResourceLocalizerConfigurer

AnnotationBuilder for ResourceLocalizer.

Author:

Janne Valkealahti

Constructor Summary

Constructors

Constructor and Description
YarnResourceLocalizerBuilder() Instantiates a new yarn resource localizer builder.

Method Summary

Methods

Modifier and Type	Method and Description
void	configuration(org.apache.hadoop.conf.Configuration configuration)
YarnResourceLocalizerConfigurer	defaultLocalResourceType(org.apache.hadoop.yarn.api.records.LocalResourceType type)
YarnResourceLocalizerConfigurer	defaultLocalResourceVisibility(org.apache.hadoop.yarn.api.records.LocalResourceVisibility visibility)
protected ResourceLocalizer	performBuild() Subclasses must implement this method to build the object that is being returned.
void	setCopyEntries(java.util.Collection<LocalResourcesFactoryBean.CopyEntry> copyEntries)
void	setHdfsEntries(java.util.Collection<LocalResourcesFactoryBean.TransferEntry> transferEntries)
void	setHdfsEntries(java.lang.String id, java.util.Collection<LocalResourcesFactoryBean.TransferEntry> transferEntries)
void	setRawCopyEntries(java.util.Collection<LocalResourcesFactoryBean.RawCopyEntry> rawEntries)
YarnResourceLocalizerConfigurer	stagingDirectory(java.lang.String stagingDirectory) Specify a staging directory.
LocalResourcesCopyConfigurer	withCopy() Specify configuration options as properties with a DefaultLocalResourcesCopyConfigurer.
LocalResourcesHdfsConfigurer	withHdfs() Specify configuration options as properties with a DefaultLocalResourcesHdfsConfigurer.
LocalResourcesHdfsConfigurer	withHdfs(java.lang.String id) Specify configuration options as properties with a DefaultLocalResourcesHdfsConfigurer with an identifier.

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()

Instantiates a new yarn resource localizer builder.

Method Detail

performBuild

protected ResourceLocalizer 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<ResourceLocalizer,YarnResourceLocalizerConfigurer,YarnResourceLocalizerBuilder>

Returns:

Object build by this builder

Throws:

java.lang.Exception - on error

withCopy

public LocalResourcesCopyConfigurer withCopy()
                                      throws java.lang.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:

java.lang.Exception - if error occurred

withHdfs

public LocalResourcesHdfsConfigurer withHdfs()
                                      throws java.lang.Exception

Description copied from interface: YarnResourceLocalizerConfigurer

Specify configuration options as properties with a DefaultLocalResourcesHdfsConfigurer.
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:

LocalResourcesHdfsConfigurer for chaining

Throws:

java.lang.Exception - if error occurred

withHdfs

public LocalResourcesHdfsConfigurer withHdfs(java.lang.String id)
                                      throws java.lang.Exception

Description copied from interface: YarnResourceLocalizerConfigurer

Specify configuration options as properties with a DefaultLocalResourcesHdfsConfigurer with an identifier.

Specified by:

withHdfs in interface YarnResourceLocalizerConfigurer

Parameters:

id - the identifier

Returns:

LocalResourcesHdfsConfigurer for chaining

Throws:

java.lang.Exception - if error occurred

See Also:

YarnResourceLocalizerConfigurer.withHdfs()

stagingDirectory

public YarnResourceLocalizerConfigurer stagingDirectory(java.lang.String stagingDirectory)

Description copied from interface: YarnResourceLocalizerConfigurer

Specify a staging directory.

Specified by:

stagingDirectory in interface YarnResourceLocalizerConfigurer

Parameters:

stagingDirectory - the staging directory

Returns:

YarnResourceLocalizerConfigurer for chaining

configuration

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

defaultLocalResourceType

public YarnResourceLocalizerConfigurer defaultLocalResourceType(org.apache.hadoop.yarn.api.records.LocalResourceType type)

defaultLocalResourceVisibility

public YarnResourceLocalizerConfigurer defaultLocalResourceVisibility(org.apache.hadoop.yarn.api.records.LocalResourceVisibility visibility)

setCopyEntries

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

setHdfsEntries

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

setHdfsEntries

public void setHdfsEntries(java.lang.String id,
                  java.util.Collection<LocalResourcesFactoryBean.TransferEntry> transferEntries)

setRawCopyEntries

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