YarnEnvironmentBuilder (Spring for Apache Hadoop 2.5.0.RELEASE API)

java.lang.Object
- org.springframework.data.hadoop.config.common.annotation.AbstractAnnotationBuilder<O>
- - org.springframework.data.hadoop.config.common.annotation.AbstractConfiguredAnnotationBuilder<java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>>,YarnEnvironmentConfigurer,YarnEnvironmentBuilder>
  - - org.springframework.yarn.config.annotation.builders.YarnEnvironmentBuilder

実装済みのインターフェース一覧:: AnnotationBuilder<java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>>>, PropertiesConfigurerAware, YarnEnvironmentConfigurer

public final class YarnEnvironmentBuilder
extends AbstractConfiguredAnnotationBuilder<java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>>,YarnEnvironmentConfigurer,YarnEnvironmentBuilder>
implements PropertiesConfigurerAware, YarnEnvironmentConfigurer

Yarn 環境の場合は AnnotationBuilder。

作成者:: Janne Valkealahti

コンストラクター概要
コンストラクター
コンストラクターと説明
YarnEnvironmentBuilder()
新しい yarn 環境ビルダーをインスタンス化します。

コンストラクター
コンストラクターと説明
`YarnEnvironmentBuilder()` 新しい yarn 環境ビルダーをインスタンス化します。

方法の概要

メソッド
修飾子と型	メソッドと説明
`void`	`addClasspathEntries(java.lang.String id, java.util.ArrayList<java.lang.String> classpathEntries)` クラスパスエントリを追加します。
`void`	`configuration(org.apache.hadoop.conf.Configuration configuration)` 糸の構成を設定します。
`void`	`configureProperties(java.util.Properties properties)` `Properties` を構成します。
`YarnEnvironmentConfigurer`	`entry(java.lang.String key, java.lang.String value)` 環境変数を指定します。
`YarnEnvironmentConfigurer`	`entry(java.lang.String id, java.lang.String key, java.lang.String value)` 識別子を使用して環境変数を指定します。
`YarnEnvironmentConfigurer`	`includeLocalSystemEnv(boolean includeLocalSystemEnv)` 既存のシステム環境変数を自動的に含めるかどうかを指定します。
`YarnEnvironmentConfigurer`	`includeLocalSystemEnv(java.lang.String id, boolean includeLocalSystemEnv)` 既存のシステム環境変数を識別子とともに自動的に含めるかどうかを指定します。
`protected java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>>`	`performBuild()` サブクラスはこのメソッドを実装して、返されるオブジェクトを構築する必要があります。
`YarnEnvironmentConfigurer`	`propertiesLocation(java.lang.String... locations)` プロパティの場所を指定します。
`YarnEnvironmentConfigurer`	`propertiesLocationId(java.lang.String id, java.lang.String[] locations)` 識別子を使用してプロパティの場所を指定します。
`void`	`setDefaultMapreduceAppClasspath(java.lang.String id, java.lang.String defaultMapreduceAppClasspath)` デフォルトの mr アプリクラスパスを設定します。
`void`	`setDefaultYarnAppClasspath(java.lang.String id, java.lang.String defaultYarnAppClasspath)` デフォルトの yarn アプリクラスパスを設定します。
`void`	`setDelimiter(java.lang.String id, java.lang.String delimiter)` 区切り文字を設定します。
`void`	`setIncludeBaseDirectory(java.lang.String id, boolean includeBaseDirectory)` インクルードベースディレクトリを設定します。
`void`	`setUseDefaultMapreduceClasspath(java.lang.String id, boolean useDefaultClasspath)` デフォルトのクラスパスを設定します。
`void`	`setUseDefaultYarnClasspath(java.lang.String id, boolean useDefaultClasspath)` デフォルトのクラスパスを設定します。
`EnvironmentClasspathConfigurer`	`withClasspath()` クラスパス環境変数を指定します。
`EnvironmentClasspathConfigurer`	`withClasspath(java.lang.String id)` 識別子を使用してクラスパス環境変数を指定します。
`PropertiesConfigurer<YarnEnvironmentConfigurer>`	`withProperties()` `PropertiesConfigurer` を使用してプロパティを指定します。
`PropertiesConfigurer<YarnEnvironmentConfigurer>`	`withProperties(java.lang.String id)` 識別子付きの `PropertiesConfigurer` を使用してプロパティを指定します。

クラス 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

クラス org.springframework.data.hadoop.config.common.annotation.AbstractAnnotationBuilder から継承されたメソッド
build, getObject

クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- コンストラクターの詳細
  - YarnEnvironmentBuilder
```
public YarnEnvironmentBuilder()
```
    新しい yarn 環境ビルダーをインスタンス化します。
- メソッドの詳細
  - performBuild
```
protected java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> performBuild()
                                                                                                 throws java.lang.Exception
```
    クラスからコピーされた説明: AbstractConfiguredAnnotationBuilder
    サブクラスはこのメソッドを実装して、返されるオブジェクトを構築する必要があります。
    次で指定:
    クラス AbstractConfiguredAnnotationBuilder<java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>>,YarnEnvironmentConfigurer, YarnEnvironmentBuilder> の performBuild
    戻り値:
    このビルダーによってビルドされるオブジェクト
    例外:
    java.lang.Exception - エラー時
  - configureProperties
```
public void configureProperties(java.util.Properties properties)
```
    インターフェースからコピーされた説明: PropertiesConfigurerAware
    Properties を構成します。
    次で指定:
    インターフェース PropertiesConfigurerAware 内の configureProperties
    パラメーター:
    properties - プロパティ
  - withClasspath
```
public EnvironmentClasspathConfigurer withClasspath()
                                             throws java.lang.Exception
```
    インターフェースからコピーされた説明: YarnEnvironmentConfigurer
    クラスパス環境変数を指定します。
    新しい DefaultEnvironmentClasspathConfigurer を現在のビルダーに適用します。JavaConfig と XML の同等のものを以下に示します。
    JavaConfig:
```
 public void configure(YarnEnvironmentBuilder environment) throws Exception {
   environment
     .withClasspath()
       .entry("cpEntry1")
       .entry("cpEntry2")
       .useDefaultYarnClasspath(true);
 }
 
```
    XML:
```
 <yarn:environment>
   <yarn:classpath use-yarn-app-classpath="true" delimiter=":">
     cpEntry1
     cpEntry2
   </yarn:classpath>
 </yarn:environment>
 
```
    次で指定:
    インターフェース YarnEnvironmentConfigurer 内の withClasspath
    戻り値:
    クラスパスの EnvironmentClasspathConfigurer
    例外:
    java.lang.Exception - エラーが発生した場合
  - withClasspath
```
public EnvironmentClasspathConfigurer withClasspath(java.lang.String id)
                                             throws java.lang.Exception
```
    インターフェースからコピーされた説明: YarnEnvironmentConfigurer
    識別子を使用してクラスパス環境変数を指定します。
    次で指定:
    インターフェース YarnEnvironmentConfigurer 内の withClasspath
    パラメーター:
    id - 識別子
    戻り値:
    クラスパスの EnvironmentClasspathConfigurer
    例外:
    java.lang.Exception - エラーが発生した場合
    関連事項:
    YarnEnvironmentConfigurer.withClasspath()
  - entry
```
public YarnEnvironmentConfigurer entry(java.lang.String key,
                              java.lang.String value)
```
    インターフェースからコピーされた説明: YarnEnvironmentConfigurer
    環境変数を指定します。
    JavaConfig:
```
 public void configure(YarnEnvironmentConfigure environment) throws Exception {
   environment
     .entry("myKey1","myValue1")
     .entry("myKey2","myValue2");
 }
 
```
    XML:
```
 <yarn:environment>
   myKey1=myValue1
   myKey2=myValue2
 </yarn:environment>
 
```
    次で指定:
    インターフェース YarnEnvironmentConfigurer 内の entry
    パラメーター:
    key - 環境キー
    value - 環境価値
    戻り値:
    連鎖用 YarnEnvironmentConfigurer
  - entry
```
public YarnEnvironmentConfigurer entry(java.lang.String id,
                              java.lang.String key,
                              java.lang.String value)
```
    インターフェースからコピーされた説明: YarnEnvironmentConfigurer
    識別子を使用して環境変数を指定します。
    次で指定:
    インターフェース YarnEnvironmentConfigurer 内の entry
    パラメーター:
    id - 識別子
    key - 環境キー
    value - 環境価値
    戻り値:
    連鎖用 YarnEnvironmentConfigurer
    関連事項:
    YarnEnvironmentConfigurer.entry(String, String)
  - propertiesLocation
```
public YarnEnvironmentConfigurer propertiesLocation(java.lang.String... locations)
                                             throws java.io.IOException
```
    インターフェースからコピーされた説明: YarnEnvironmentConfigurer
    プロパティの場所を指定します。
    JavaConfig:
```
 public void configure(YarnEnvironmentConfigure environment) throws Exception {
   environment
     .entry("myKey1","myValue1")
     .entry("myKey2","myValue2")
     .propertiesLocation("cfg-1.properties", "cfg-2.properties");
 }
 
```
    XML:
```
 <yarn:environment properties-location="cfg-1.properties, cfg-2.properties">
   myKey1=myValue1
   myKey2=myValue2
 </yarn:environment>
 
```
    次で指定:
    インターフェース YarnEnvironmentConfigurer 内の propertiesLocation
    パラメーター:
    locations - プロパティファイルの場所
    戻り値:
    連鎖用 YarnEnvironmentConfigurer
    例外:
    java.io.IOException - エラーが発生した場合
  - propertiesLocationId
```
public YarnEnvironmentConfigurer propertiesLocationId(java.lang.String id,
                                             java.lang.String[] locations)
                                               throws java.io.IOException
```
    インターフェースからコピーされた説明: YarnEnvironmentConfigurer
    識別子を使用してプロパティの場所を指定します。
    次で指定:
    インターフェース YarnEnvironmentConfigurer 内の propertiesLocationId
    パラメーター:
    id - 識別子
    locations - プロパティファイルの場所
    戻り値:
    連鎖用 YarnEnvironmentConfigurer
    例外:
    java.io.IOException - エラーが発生した場合
    関連事項:
    YarnEnvironmentConfigurer.propertiesLocation(String...)
  - includeLocalSystemEnv
```
public YarnEnvironmentConfigurer includeLocalSystemEnv(boolean includeLocalSystemEnv)
```
    インターフェースからコピーされた説明: YarnEnvironmentConfigurer
    既存のシステム環境変数を自動的に含めるかどうかを指定します。
    JavaConfig:
```
 public void configure(YarnEnvironmentConfigure environment) throws Exception {
   environment
     .includeLocalSystemEnv(false);
 }
 
```
    XML:
```
 <yarn:environment include-local-system-env="false"/>
 
```
    次で指定:
    インターフェース YarnEnvironmentConfigurer 内の includeLocalSystemEnv
    パラメーター:
    includeLocalSystemEnv - システム環境変数を含めるかどうか
    戻り値:
    連鎖用 YarnEnvironmentConfigurer
  - includeLocalSystemEnv
```
public YarnEnvironmentConfigurer includeLocalSystemEnv(java.lang.String id,
                                              boolean includeLocalSystemEnv)
```
    インターフェースからコピーされた説明: YarnEnvironmentConfigurer
    既存のシステム環境変数を識別子とともに自動的に含めるかどうかを指定します。
    次で指定:
    インターフェース YarnEnvironmentConfigurer 内の includeLocalSystemEnv
    パラメーター:
    id - 識別子
    includeLocalSystemEnv - システム環境変数を含めるかどうか
    戻り値:
    連鎖用 YarnEnvironmentConfigurer
    関連事項:
    YarnEnvironmentConfigurer.includeLocalSystemEnv(boolean)
  - withProperties
```
public PropertiesConfigurer<YarnEnvironmentConfigurer> withProperties()
                                                               throws java.lang.Exception
```
    インターフェースからコピーされた説明: YarnEnvironmentConfigurer
    PropertiesConfigurer を使用してプロパティを指定します。
    JavaConfig:
```
 public void configure(YarnEnvironmentConfigure environment) throws Exception {
   Properties props = new Properties();
   environment
     .withProperties()
       .properties(props)
       .property("myKey1", ",myValue1")
       .and();
 }
 
```
    XML:
```
 <util:properties id="props" location="props.properties"/>
   <prop key="myKey1">myValue1</prop>
 </util:properties>
 <yarn:environment properties-ref="props"/>
 
```
    次で指定:
    インターフェース YarnEnvironmentConfigurer 内の withProperties
    戻り値:
    連鎖用 PropertiesConfigurer
    例外:
    java.lang.Exception - エラーが発生した場合
  - withProperties
```
public PropertiesConfigurer<YarnEnvironmentConfigurer> withProperties(java.lang.String id)
                                                               throws java.lang.Exception
```
    インターフェースからコピーされた説明: YarnEnvironmentConfigurer
    識別子付きの PropertiesConfigurer を使用してプロパティを指定します。
    次で指定:
    インターフェース YarnEnvironmentConfigurer 内の withProperties
    パラメーター:
    id - 識別子
    戻り値:
    連鎖用 PropertiesConfigurer
    例外:
    java.lang.Exception - エラーが発生した場合
    関連事項:
    YarnEnvironmentConfigurer.withProperties()
  - addClasspathEntries
```
public void addClasspathEntries(java.lang.String id,
                       java.util.ArrayList<java.lang.String> classpathEntries)
```
    クラスパスエントリを追加します。
    パラメーター:
    id - ID
    classpathEntries - クラスパスエントリ
  - configuration
```
public void configuration(org.apache.hadoop.conf.Configuration configuration)
```
    糸の構成を設定します。
    パラメーター:
    configuration - 糸の構成
  - setUseDefaultYarnClasspath
```
public void setUseDefaultYarnClasspath(java.lang.String id,
                              boolean useDefaultClasspath)
```
    デフォルトのクラスパスを設定します。
    パラメーター:
    id - ID
    useDefaultClasspath - 新しいデフォルトのクラスパス
  - setUseDefaultMapreduceClasspath
```
public void setUseDefaultMapreduceClasspath(java.lang.String id,
                                   boolean useDefaultClasspath)
```
    デフォルトのクラスパスを設定します。
    パラメーター:
    id - ID
    useDefaultClasspath - 新しいデフォルトのクラスパス
  - setIncludeBaseDirectory
```
public void setIncludeBaseDirectory(java.lang.String id,
                           boolean includeBaseDirectory)
```
    インクルードベースディレクトリを設定します。
    パラメーター:
    id - ID
    includeBaseDirectory - 新しいインクルードベースディレクトリ
  - setDelimiter
```
public void setDelimiter(java.lang.String id,
                java.lang.String delimiter)
```
    区切り文字を設定します。
    パラメーター:
    id - ID
    delimiter - 新しい区切り文字
  - setDefaultYarnAppClasspath
```
public void setDefaultYarnAppClasspath(java.lang.String id,
                              java.lang.String defaultYarnAppClasspath)
```
    デフォルトの yarn アプリクラスパスを設定します。
    パラメーター:
    id - ID
    defaultYarnAppClasspath - 新しいデフォルトの yarn アプリクラスパス
  - setDefaultMapreduceAppClasspath
```
public void setDefaultMapreduceAppClasspath(java.lang.String id,
                                   java.lang.String defaultMapreduceAppClasspath)
```
    デフォルトの mr アプリクラスパスを設定します。
    パラメーター:
    id - ID
    defaultMapreduceAppClasspath - 新しいデフォルトの mr アプリクラスパス

クラス YarnEnvironmentBuilder

コンストラクター概要

方法の概要

クラス org.springframework.data.hadoop.config.common.annotation.AbstractConfiguredAnnotationBuilder から継承されたメソッド

クラス org.springframework.data.hadoop.config.common.annotation.AbstractAnnotationBuilder から継承されたメソッド

クラス java.lang.Object から継承されたメソッド

コンストラクターの詳細

YarnEnvironmentBuilder

メソッドの詳細

performBuild

configureProperties

withClasspath

withClasspath

entry

entry

propertiesLocation

propertiesLocationId

includeLocalSystemEnv

includeLocalSystemEnv

withProperties

withProperties

addClasspathEntries

configuration

setUseDefaultYarnClasspath

setUseDefaultMapreduceClasspath

setIncludeBaseDirectory

setDelimiter

setDefaultYarnAppClasspath

setDefaultMapreduceAppClasspath