YarnEnvironmentConfigurer (Spring for Apache Hadoop 2.5.0.RELEASE API)

すべての既知の実装クラス:: YarnEnvironmentBuilder

public interface YarnEnvironmentConfigurer

SpringYarnConfigurerAdapter から使用される YarnEnvironmentBuilder のインターフェース。

通常、構成は以下のように使用されます。

 @Configuration
 @EnableYarn
 static class Config extends SpringYarnConfigurerAdapter {

   @Override
   public void configure(YarnEnvironmentBuilder environment) throws Exception {
     environment
       .withClasspath()
         .entry("cpEntry1")
         .entry("cpEntry2")
         .useDefaultYarnClasspath(true);
   }

 }

作成者:: Janne Valkealahti

メソッドのサマリー

メソッド
修飾子と型	メソッドと説明
`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)` 既存のシステム環境変数を識別子とともに自動的に含めるかどうかを指定します。
`YarnEnvironmentConfigurer`	`propertiesLocation(java.lang.String... locations)` プロパティの場所を指定します。
`YarnEnvironmentConfigurer`	`propertiesLocationId(java.lang.String id, java.lang.String[] locations)` 識別子を使用してプロパティの場所を指定します。
`EnvironmentClasspathConfigurer`	`withClasspath()` クラスパス環境変数を指定します。
`EnvironmentClasspathConfigurer`	`withClasspath(java.lang.String id)` 識別子を使用してクラスパス環境変数を指定します。
`PropertiesConfigurer<YarnEnvironmentConfigurer>`	`withProperties()` `PropertiesConfigurer` を使用してプロパティを指定します。
`PropertiesConfigurer<YarnEnvironmentConfigurer>`	`withProperties(java.lang.String id)` 識別子付きの `PropertiesConfigurer` を使用してプロパティを指定します。

メソッドの詳細

withClasspath

EnvironmentClasspathConfigurer withClasspath()
                                             throws java.lang.Exception

クラスパス環境変数を指定します。

新しい 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>

戻り値:: クラスパスの EnvironmentClasspathConfigurer
例外:: java.lang.Exception - エラーが発生した場合

withClasspath
```
EnvironmentClasspathConfigurer withClasspath(java.lang.String id)
                                             throws java.lang.Exception
```
識別子を使用してクラスパス環境変数を指定します。
パラメーター:
id - 識別子
戻り値:
クラスパスの EnvironmentClasspathConfigurer
例外:
java.lang.Exception - エラーが発生した場合
関連事項:
withClasspath()

entry

YarnEnvironmentConfigurer entry(java.lang.String key,
                              java.lang.String value)

環境変数を指定します。
JavaConfig:

 public void configure(YarnEnvironmentConfigure environment) throws Exception {
   environment
     .entry("myKey1","myValue1")
     .entry("myKey2","myValue2");
 }

XML:

 <yarn:environment>
   myKey1=myValue1
   myKey2=myValue2
 </yarn:environment>

パラメーター:: key - 環境キー; value - 環境価値
戻り値:: 連鎖用 YarnEnvironmentConfigurer

entry
```
YarnEnvironmentConfigurer entry(java.lang.String id,
                              java.lang.String key,
                              java.lang.String value)
```
識別子を使用して環境変数を指定します。
パラメーター:
id - 識別子
key - 環境キー
value - 環境価値
戻り値:
連鎖用 YarnEnvironmentConfigurer
関連事項:
entry(String, String)

propertiesLocation

YarnEnvironmentConfigurer propertiesLocation(java.lang.String... locations)
                                             throws java.io.IOException

プロパティの場所を指定します。
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>

パラメーター:: locations - プロパティファイルの場所
戻り値:: 連鎖用 YarnEnvironmentConfigurer
例外:: java.io.IOException - エラーが発生した場合

propertiesLocationId
```
YarnEnvironmentConfigurer propertiesLocationId(java.lang.String id,
                                             java.lang.String[] locations)
                                               throws java.io.IOException
```
識別子を使用してプロパティの場所を指定します。
パラメーター:
id - 識別子
locations - プロパティファイルの場所
戻り値:
連鎖用 YarnEnvironmentConfigurer
例外:
java.io.IOException - エラーが発生した場合
関連事項:
propertiesLocation(String...)

includeLocalSystemEnv

YarnEnvironmentConfigurer includeLocalSystemEnv(boolean includeLocalSystemEnv)

既存のシステム環境変数を自動的に含めるかどうかを指定します。
JavaConfig:

 public void configure(YarnEnvironmentConfigure environment) throws Exception {
   environment
     .includeLocalSystemEnv(false);
 }

XML:

 <yarn:environment include-local-system-env="false"/>

パラメーター:: includeLocalSystemEnv - システム環境変数を含めるかどうか
戻り値:: 連鎖用 YarnEnvironmentConfigurer

includeLocalSystemEnv
```
YarnEnvironmentConfigurer includeLocalSystemEnv(java.lang.String id,
                                              boolean includeLocalSystemEnv)
```
既存のシステム環境変数を識別子とともに自動的に含めるかどうかを指定します。
パラメーター:
id - 識別子
includeLocalSystemEnv - システム環境変数を含めるかどうか
戻り値:
連鎖用 YarnEnvironmentConfigurer
関連事項:
includeLocalSystemEnv(boolean)

withProperties

PropertiesConfigurer<YarnEnvironmentConfigurer> withProperties()
                                                               throws java.lang.Exception

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

戻り値:: 連鎖用 PropertiesConfigurer
例外:: java.lang.Exception - エラーが発生した場合

withProperties
```
PropertiesConfigurer<YarnEnvironmentConfigurer> withProperties(java.lang.String id)
                                                               throws java.lang.Exception
```
識別子付きの PropertiesConfigurer を使用してプロパティを指定します。
パラメーター:
id - 識別子
戻り値:
連鎖用 PropertiesConfigurer
例外:
java.lang.Exception - エラーが発生した場合
関連事項:
withProperties()

インターフェース YarnEnvironmentConfigurer

メソッドのサマリー

メソッドの詳細

withClasspath

withClasspath

entry

entry

propertiesLocation

propertiesLocationId

includeLocalSystemEnv

includeLocalSystemEnv

withProperties

withProperties