YarnClientBuilder (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<YarnClient,YarnClientConfigurer,YarnClientBuilder>
  - - org.springframework.yarn.config.annotation.builders.YarnClientBuilder

実装済みのインターフェース一覧:
AnnotationBuilder<YarnClient>, YarnClientConfigurer
```
public class YarnClientBuilder
extends AbstractConfiguredAnnotationBuilder<YarnClient,YarnClientConfigurer,YarnClientBuilder>
implements YarnClientConfigurer
```
YarnClient の場合は AnnotationBuilder。
作成者:
Janne Valkealahti

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

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

方法の概要

メソッド
修飾子と型	メソッドと説明
`YarnClientConfigurer`	`appName(java.lang.String appName)` yarn アプリケーション名を指定します。
`YarnClientConfigurer`	`appType(java.lang.String appType)` 糸の適用型を指定します。
`YarnClientConfigurer`	`clientClass(java.lang.Class<? extends YarnClient> clazz)` `YarnClient` クラスを指定します。
`YarnClientConfigurer`	`clientClass(java.lang.String clazz)` 完全修飾クラス名として `YarnClient` を指定します。
`void`	`configuration(org.apache.hadoop.conf.Configuration configuration)`
`YarnClientConfigurer`	`labelExpression(java.lang.String labelExpression)` yarn アプリケーションの送信ラベル式を指定します。
`YarnClientConfigurer`	`masterCommands(java.lang.String... commands)` アプリケーションマスターを起動するために使用されるコマンドの生の配列を指定します。
`YarnClientConfigurer`	`memory(int memory)` Yarn アプリケーションコンテナーのメモリ予約を指定します。
`YarnClientConfigurer`	`memory(java.lang.String memory)` Yarn アプリケーションコンテナーのメモリ予約を指定します。
`protected YarnClient`	`performBuild()` サブクラスはこのメソッドを実装して、返されるオブジェクトを構築する必要があります。
`YarnClientConfigurer`	`priority(java.lang.Integer priority)` 糸の適用優先度を指定します。
`YarnClientConfigurer`	`queue(java.lang.String queue)` yarn アプリケーションの送信キューを指定します。
`void`	`setCommands(java.lang.String... commands)`
`void`	`setEnvironment(java.util.Map<java.lang.String,java.lang.String> environment)`
`void`	`setResourceLocalizer(ResourceLocalizer resourceLocalizer)`
`YarnClientConfigurer`	`virtualCores(java.lang.Integer virtualCores)` Yarn アプリケーションの仮想コアリソース数を指定します。
`DefaultClientMasterRunnerConfigurer`	`withMasterRunner()` `YarnAppmaster` を起動するためのコマンドを追加します。

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

- コンストラクターの詳細
  - YarnClientBuilder
```
public YarnClientBuilder()
```
    新しい yarn クライアントビルダーをインスタンス化します。
- メソッドの詳細
  - performBuild
```
protected YarnClient performBuild()
                           throws java.lang.Exception
```
    クラスからコピーされた説明: AbstractConfiguredAnnotationBuilder
    サブクラスはこのメソッドを実装して、返されるオブジェクトを構築する必要があります。
    次で指定:
    クラス AbstractConfiguredAnnotationBuilder<YarnClient, YarnClientConfigurer, YarnClientBuilder> の performBuild
    戻り値:
    このビルダーによってビルドされるオブジェクト
    例外:
    java.lang.Exception - エラー時
  - withMasterRunner
```
public DefaultClientMasterRunnerConfigurer withMasterRunner()
                                                     throws java.lang.Exception
```
    YarnAppmaster を起動するためのコマンドを追加します。
    次で指定:
    インターフェース YarnClientConfigurer 内の withMasterRunner
    戻り値:
    クライアントマスターランナーコンフィギュレータ
    例外:
    java.lang.Exception - 例外
  - appName
```
public YarnClientConfigurer appName(java.lang.String appName)
```
    インターフェースからコピーされた説明: YarnClientConfigurer
    yarn アプリケーション名を指定します。
    
    JavaConfig:
```
 public void configure(YarnClientConfigure client) throws Exception {
   client
     .appName("myAppName");
 }
 
```
    XML:
```
 <yarn:client app-name="myAppName"/>
 
```
    次で指定:
    インターフェース YarnClientConfigurer 内の appName
    パラメーター:
    appName - Yarn アプリケーション名
    戻り値:
    連鎖用 YarnClientConfigurer
  - appType
```
public YarnClientConfigurer appType(java.lang.String appType)
```
    インターフェースからコピーされた説明: YarnClientConfigurer
    yarn アプリケーション型を指定します。型は、リソースマネージャーからアプリケーションを照会するときにユーザーがフィールドとして見る単純な文字列です。例: MapReduce ジョブは型 MAPREDUCE を使用しており、他のアプリケーションはデフォルトで YARN になります。
    
    JavaConfig:
```
 public void configure(YarnClientConfigure client) throws Exception {
   client
     .appType("BOOT");
 }
 
```
    XML:
    同等のものはありません
    次で指定:
    インターフェース YarnClientConfigurer 内の appType
    パラメーター:
    appType - Yarn アプリケーション型
    戻り値:
    連鎖用 YarnClientConfigurer
  - masterCommands
```
public YarnClientConfigurer masterCommands(java.lang.String... commands)
```
    インターフェースからコピーされた説明: YarnClientConfigurer
    アプリケーションマスターを起動するために使用されるコマンドの生の配列を指定します。
    
    JavaConfig:
```
 public void configure(YarnClientConfigure client) throws Exception {
   client
     .masterCommands("java -jar MyApp.jar", "1><LOG_DIR>/Appmaster.stdout", "2><LOG_DIR>/Appmaster.stderr");
 }
 
```
    XML:
```
 <yarn:client>
   <yarn:master-command>
     <![CDATA[
     java -jar MyApp.jar
     1><LOG_DIR>/Appmaster.stdout
     2><LOG_DIR>/Appmaster.stderr
     ]]>
   </yarn:master-command>
 </yarn:client>
 
```
    次で指定:
    インターフェース YarnClientConfigurer 内の masterCommands
    パラメーター:
    commands - Yarn コンテナーコマンド
    戻り値:
    連鎖用 YarnAppmasterConfigurer
  - priority
```
public YarnClientConfigurer priority(java.lang.Integer priority)
```
    インターフェースからコピーされた説明: YarnClientConfigurer
    糸の適用優先度を指定します。
    
    JavaConfig:
```
 public void configure(YarnClientConfigure client) throws Exception {
   client
     .priority(0);
 }
 
```
    XML:
```
 <yarn:client priority="0"/>
 
```
    次で指定:
    インターフェース YarnClientConfigurer 内の priority
    パラメーター:
    priority - Yarn の申請優先順位
    戻り値:
    連鎖用 YarnClientConfigurer
  - queue
```
public YarnClientConfigurer queue(java.lang.String queue)
```
    インターフェースからコピーされた説明: YarnClientConfigurer
    yarn アプリケーション送信キューを指定します。指定されたキューはクライアントリクエストの 1 つですが、必ずしもアプリケーションが配置されるキューであるとは限りません。一部の Yarn スケジューラはこれを変更することを選択する可能性があるため、ユーザーは Yarn の設定方法に注意する必要があります。
    
    JavaConfig:
```
 public void configure(YarnClientConfigure client) throws Exception {
   client
     .queue("default");
 }
 
```
    XML:
```
 <yarn:client queue="default"/>
 
```
    次で指定:
    インターフェース YarnClientConfigurer 内の queue
    パラメーター:
    queue - Yarn アプリケーション提出キュー
    戻り値:
    連鎖用 YarnClientConfigurer
  - labelExpression
```
public YarnClientConfigurer labelExpression(java.lang.String labelExpression)
```
    インターフェースからコピーされた説明: YarnClientConfigurer
    yarn アプリケーション送信ラベル式を指定します。これを設定すると、リソースリクエストでラベル式を設定していないこのアプリケーションのすべてのコンテナーは、このラベル式を満たすノードでのみリソースが割り当てられます。このアプリとリソースリクエストの異なるラベル式が同時に設定されている場合、コンテナーを割り当てるときにリソースリクエストで設定されたラベル式が使用されます。
    
    JavaConfig:
```
 public void configure(YarnClientConfigure client) throws Exception {
   client
     .labelExpression("expression");
 }
 
```
    XML:
    同等のものはありません
    次で指定:
    インターフェース YarnClientConfigurer 内の labelExpression
    パラメーター:
    labelExpression - Yarn アプリケーションラベル式
    戻り値:
    連鎖用 YarnClientConfigurer
  - memory
```
public YarnClientConfigurer memory(int memory)
```
    インターフェースからコピーされた説明: YarnClientConfigurer
    yarn アプリケーションコンテナーのメモリ予約を指定します。memory 引数は MegaBytes として指定されます。
    
    JavaConfig:
```
 public void configure(YarnClientConfigure client) throws Exception {
   client
     .memory(1024);
 }
 
```
    XML:
```
 <yarn:client memory="1024"/>
 
```
    次で指定:
    インターフェース YarnClientConfigurer 内の memory
    パラメーター:
    memory - Yarn アプリケーションコンテナーのメモリ予約
    戻り値:
    連鎖用 YarnClientConfigurer
    関連事項:
    YarnClientConfigurer.memory(String)
  - memory
```
public YarnClientConfigurer memory(java.lang.String memory)
```
    インターフェースからコピーされた説明: YarnClientConfigurer
    yarn アプリケーションコンテナーのメモリ予約を指定します。値が単純な数値の場合、memory 引数は MegaBytes として指定されます。1G や 500M などのショートカットを使用できます。これらはそれぞれ 1024 と 500 に変換されます。
    このメソッドは #memory(int) と同等なので、引数を String として指定できます。
    注意 : 1000K や 1000B などの低すぎる設定は使用しないように注意してください。これらの設定は完全な MB に切り捨てられ、ゼロになります。また、値が高すぎると、リソース割り当ての動作が悪くなる可能性があります。
    
    JavaConfig:
```
 public void configure(YarnClientConfigure client) throws Exception {
   client
     .memory("1G");
 }
 
```
    XML:
```
 <yarn:client memory="1024"/>
 
```
    次で指定:
    インターフェース YarnClientConfigurer 内の memory
    パラメーター:
    memory - Yarn アプリケーションコンテナーのメモリ予約
    戻り値:
    連鎖用 YarnClientConfigurer
  - virtualCores
```
public YarnClientConfigurer virtualCores(java.lang.Integer virtualCores)
```
    インターフェースからコピーされた説明: YarnClientConfigurer
    Yarn アプリケーションの仮想コアリソース数を指定します。
    
    JavaConfig:
```
 public void configure(YarnClientConfigure client) throws Exception {
   client
     .virtualCores(1);
 }
 
```
    XML:
```
 <yarn:client virtualcores="1"/>
 
```
    次で指定:
    インターフェース YarnClientConfigurer 内の virtualCores
    パラメーター:
    virtualCores - Yarn アプリケーションの仮想コアリソース数
    戻り値:
    連鎖用 YarnClientConfigurer
  - clientClass
```
public YarnClientConfigurer clientClass(java.lang.Class<? extends YarnClient> clazz)
```
    インターフェースからコピーされた説明: YarnClientConfigurer
    YarnClient クラスを指定します。
    
    JavaConfig:
```
 public void configure(YarnClientConfigure client) throws Exception {
   client
     .clientClass(MyYarnClient.class);
 }
 
```
    XML:
    同等のものはありません
    次で指定:
    インターフェース YarnClientConfigurer 内の clientClass
    パラメーター:
    clazz - Yarn クライアントクラス
    戻り値:
    連鎖用 YarnClientConfigurer
  - clientClass
```
public YarnClientConfigurer clientClass(java.lang.String clazz)
```
    インターフェースからコピーされた説明: YarnClientConfigurer
    完全修飾クラス名として YarnClient を指定します。
    
    JavaConfig:
```
 public void configure(YarnClientConfigure client) throws Exception {
   client
     .clientClass("com.example.MyYarnClient");
 }
 
```
    XML:
    同等のものはありません
    次で指定:
    インターフェース YarnClientConfigurer 内の clientClass
    パラメーター:
    clazz - Yarn クライアントクラス
    戻り値:
    連鎖用 YarnClientConfigurer
  - configuration
```
public void configuration(org.apache.hadoop.conf.Configuration configuration)
```
  - setCommands
```
public void setCommands(java.lang.String... commands)
```
  - setResourceLocalizer
```
public void setResourceLocalizer(ResourceLocalizer resourceLocalizer)
```
  - setEnvironment
```
public void setEnvironment(java.util.Map<java.lang.String,java.lang.String> environment)
```

クラス YarnClientBuilder

コンストラクター概要

方法の概要

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

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

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

コンストラクターの詳細

YarnClientBuilder

メソッドの詳細

performBuild

withMasterRunner

appName

appType

masterCommands

priority

queue

labelExpression

memory

memory

virtualCores

clientClass

clientClass

configuration

setCommands

setResourceLocalizer

setEnvironment