REST Resource: projects.locations.batches

リソース: バッチ

サービス内のバッチ ワークロードを表します。

JSON 表現 
{
  "name": string,
  "uuid": string,
  "createTime": string,
  "runtimeInfo": {
    object (RuntimeInfo)
  },
  "state": enum (State),
  "stateMessage": string,
  "stateTime": string,
  "creator": string,
  "labels": {
    string: string,
    ...
  },
  "runtimeConfig": {
    object (RuntimeConfig)
  },
  "environmentConfig": {
    object (EnvironmentConfig)
  },
  "operation": string,
  "stateHistory": [
    {
      object (StateHistory)
    }
  ],

  // Union field batch_config can be only one of the following:
  "pysparkBatch": {
    object (PySparkBatch)
  },
  "sparkBatch": {
    object (SparkBatch)
  },
  "sparkRBatch": {
    object (SparkRBatch)
  },
  "sparkSqlBatch": {
    object (SparkSqlBatch)
  }
  // End of list of possible types for union field batch_config.
}
フィールド
name

string

出力専用。バッチのリソース名。
uuid

string

出力専用。バッチ UUID（一意のユニバーサル識別子）。この値は、サービスがバッチを作成するときに生成されます。
createTime

string (Timestamp format)

出力専用。バッチが作成された時刻。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。
runtimeInfo

object (RuntimeInfo)

出力専用。バッチ実行に関するランタイム情報。
state

enum (State)

出力専用。バッチの状態。
stateMessage

string

出力専用。バッチの状態の詳細（状態が FAILED の場合のエラーの説明など）。
stateTime

string (Timestamp format)

出力専用。バッチが現在の状態になった時刻。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。
creator

string

出力専用。バッチを作成したユーザーのメールアドレス。
labels

map (key: string, value: string)

省略可。このバッチに関連付けるラベル。ラベルのキーは 1 ～ 63 文字で、RFC 1035 に準拠している必要があります。ラベルの値は空にできますが、指定する場合は 1 ～ 63 文字で、RFC 1035 に準拠している必要があります。1 つのバッチに関連付けることができるラベルは 32 個までです。

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }
runtimeConfig

object (RuntimeConfig)

省略可。バッチ実行のランタイム構成。
environmentConfig

object (EnvironmentConfig)

省略可。バッチ実行の環境構成。
operation

string

出力専用。このバッチに関連付けられたオペレーションのリソース名。
stateHistory[]

object (StateHistory)

出力専用。バッチの過去の状態情報。
共用体フィールド batch_config。バッチ構成のアプリケーション/フレームワーク固有の部分。batch_config は次のいずれかになります。
pysparkBatch

object (PySparkBatch)

省略可。PySpark バッチ構成。
sparkBatch

object (SparkBatch)

省略可。Spark バッチ構成。
sparkRBatch

object (SparkRBatch)

省略可。SparkR バッチ構成。
sparkSqlBatch

object (SparkSqlBatch)

省略可。SparkSql バッチ構成。

PySparkBatch

Apache PySpark バッチ ワークロードを実行するための構成。

JSON 表現 
{
  "mainPythonFileUri": string,
  "args": [
    string
  ],
  "pythonFileUris": [
    string
  ],
  "jarFileUris": [
    string
  ],
  "fileUris": [
    string
  ],
  "archiveUris": [
    string
  ]
}
フィールド
mainPythonFileUri

string

必須。Spark ドライバとして使用するメインの Python ファイルの HCFS URI。.py ファイルを指定する必要があります。
args[]

string

省略可。ドライバに渡す引数。--conf など、バッチ プロパティとして設定できる引数は含めないでください。競合が発生して、バッチが正しく送信されない可能性があります。
pythonFileUris[]

string

省略可。PySpark フレームワークに渡す Python ファイルの HCFS ファイル URI。サポートされているファイル形式: .py、.egg、.zip
jarFileUris[]

string

省略可。Spark ドライバとタスクのクラスパスに追加する JAR ファイルの HCFS URI。
fileUris[]

string

省略可。各エグゼキュータの作業ディレクトリに配置されるファイルの HCFS URI。
archiveUris[]

string

省略可。各エグゼキュータの作業ディレクトリに解凍されるアーカイブの HCFS URI。サポートされているファイル形式: .jar、.tar、.tar.gz、.tgz、.zip。

SparkBatch

Apache Spark バッチ ワークロードを実行するための構成。

JSON 表現 
{
  "args": [
    string
  ],
  "jarFileUris": [
    string
  ],
  "fileUris": [
    string
  ],
  "archiveUris": [
    string
  ],

  // Union field driver can be only one of the following:
  "mainJarFileUri": string,
  "mainClass": string
  // End of list of possible types for union field driver.
}
フィールド
args[]

string

省略可。ドライバに渡す引数。--conf など、バッチ プロパティとして設定できる引数は含めないでください。競合が発生して、バッチが正しく送信されない可能性があります。
jarFileUris[]

string

省略可。Spark ドライバとタスクのクラスパスに追加する JAR ファイルの HCFS URI。
fileUris[]

string

省略可。各エグゼキュータの作業ディレクトリに配置されるファイルの HCFS URI。
archiveUris[]

string

省略可。各エグゼキュータの作業ディレクトリに解凍されるアーカイブの HCFS URI。サポートされているファイル形式: .jar、.tar、.tar.gz、.tgz、.zip。
共用体フィールド driver。Spark ワークロードを駆動するために呼び出すメインメソッドの仕様。メインクラスを含む jar ファイルまたはメインクラス名のいずれかを指定します。メイン JAR とその JAR 内のメインクラスの両方を渡すには、JAR を jar_file_uris に追加し、main_class にメインクラス名を指定します。driver は次のいずれかになります。
mainJarFileUri

string

省略可。メインクラスを含む jar ファイルの HCFS URI。
mainClass

string

省略可。ドライバのメインクラスの名前。クラスを含む jar ファイルは、クラスパス内にあるか、jarFileUris で指定する必要があります。

SparkRBatch

Apache SparkR バッチ ワークロードを実行するための構成。

JSON 表現 
{
  "mainRFileUri": string,
  "args": [
    string
  ],
  "fileUris": [
    string
  ],
  "archiveUris": [
    string
  ]
}
フィールド
mainRFileUri

string

必須。ドライバとして使用するメインの R ファイルの HCFS URI。.R ファイルまたは .r ファイルである必要があります。
args[]

string

省略可。Spark ドライバに渡す引数。--conf など、バッチ プロパティとして設定できる引数は含めないでください。競合が発生して、バッチが正しく送信されない可能性があります。
fileUris[]

string

省略可。各エグゼキュータの作業ディレクトリに配置されるファイルの HCFS URI。
archiveUris[]

string

省略可。各エグゼキュータの作業ディレクトリに解凍されるアーカイブの HCFS URI。サポートされているファイル形式: .jar、.tar、.tar.gz、.tgz、.zip。

SparkSqlBatch

Apache Spark SQL クエリをバッチ ワークロードとして実行するための構成。

JSON 表現 
{
  "queryFileUri": string,
  "queryVariables": {
    string: string,
    ...
  },
  "jarFileUris": [
    string
  ]
}
フィールド
queryFileUri

string

必須。実行する Spark SQL クエリを含むスクリプトの HCFS URI。
queryVariables

map (key: string, value: string)

省略可。クエリ変数名と値のマッピング（Spark SQL コマンド SET name="value"; と同等）。

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }
jarFileUris[]

string

省略可。Spark CLASSPATH に追加する JAR ファイルの HCFS URI。

州

バッチの状態。

列挙型
STATE_UNSPECIFIED バッチの状態は不明です。
PENDING バッチは実行前に作成されます。
RUNNING バッチが実行中です。
CANCELLING バッチがキャンセルされています。
CANCELLED 一括解約が正常に完了しました。
SUCCEEDED バッチが正常に完了しました。
FAILED エラーが発生したため、バッチの実行が停止しました。

StateHistory

過去の状態情報。

JSON 表現 
{
  "state": enum (State),
  "stateMessage": string,
  "stateStartTime": string
}
フィールド
state

enum (State)

出力専用。履歴のこの時点でのバッチの状態。
stateMessage

string

出力専用。この時点の状態に関する詳細。
stateStartTime

string (Timestamp format)

出力専用。バッチが履歴状態になった時刻。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。

メソッド

create

 非同期で実行されるバッチ ワークロードを作成します。

delete

 バッチ ワークロード リソースを削除します。

get

 バッチ ワークロード リソースの表現を取得します。

list

 バッチ ワークロードを一覧表示します。