CloudJob interface
CloudJob を表すインターフェイス。
プロパティ
| common |
一般的な環境変数設定の一覧。 これらの環境変数は、ジョブ内のすべてのタスク (ジョブ マネージャー、ジョブ準備タスク、ジョブ解放タスクを含む) に設定されます。 個々のタスクは、同じ設定名を別の値で指定することで、ここで指定した環境設定をオーバーライドできます。 |
| constraints | ジョブの実行制約。 |
| creation |
ジョブの作成時刻。 |
| display |
ジョブの表示名。 |
| e |
ジョブの ETag。 これは不透明な文字列です。 これを使用して、ジョブが要求間で変更されたかどうかを検出できます。 特に、ジョブを更新するときに ETag を渡して、その間に他の誰もジョブを変更していない場合にのみ変更を有効にするように指定できます。 |
| execution |
ジョブの実行情報。 |
| id | アカウント内のジョブを一意に識別する文字列。 ID は大文字と小文字が区別されず、大文字と小文字が区別されません (つまり、アカウント内に大文字と小文字のみが異なる 2 つの ID がない可能性があります)。 |
| job |
ジョブの開始時に起動されるジョブ マネージャー タスクの詳細。 |
| job |
ジョブ準備タスク。 ジョブ準備タスクは、ジョブの他のタスクの前に各コンピューティング ノードで実行される特別なタスクです。 |
| job |
ジョブ解放タスク。 ジョブ解放タスクは、ジョブの他のタスクを実行した各コンピューティング ノードで、ジョブの終了時に実行される特別なタスクです。 |
| last |
ジョブの最終変更時刻。 これは、ジョブの状態や優先度など、ジョブ レベルのデータが最後に変更された時刻です。 新しいタスクの追加やタスクの状態の変更など、タスク レベルの変更は考慮されません。 |
| metadata | ジョブにメタデータとして関連付けられている名前と値のペアの一覧。 Batch サービスは、メタデータに意味を割り当てません。これは、ユーザー コードの使用のみを目的とします。 |
| network |
ジョブのネットワーク構成。 |
| on |
ジョブ内のすべてのタスクが完了状態のときに Batch サービスが実行する必要があるアクション。 既定値は noaction です。 指定できる値は、'noAction'、'terminateJob' です。 |
| on |
ジョブ内のタスクが失敗したときに Batch サービスが実行する必要があるアクション。 failureInfo がある場合、タスクは失敗したと見なされます。 failureInfo は、再試行回数を使い果たした後にタスクが 0 以外の終了コードで完了した場合、またはリソース ファイルのダウンロード エラーが原因でタスクの開始エラーが発生した場合に設定されます。 既定値は noaction です。 指定できる値は、'noAction'、'performExitOptionsJobAction' です。 |
| pool |
ジョブに関連付けられているプール設定。 |
| previous |
ジョブの以前の状態。 ジョブが初期アクティブ状態の場合、このプロパティは設定されません。 使用可能な値は、'active'、'disableding'、'disabled'、'enabling'、'terminating'、'completed'、'deleting' です。 |
| previous |
ジョブが以前の状態になった時刻。 ジョブが初期アクティブ状態の場合、このプロパティは設定されません。 |
| priority | ジョブの優先順位。 優先度の値の範囲は -1000 から 1000 までで、-1000 は最も低い優先度、1000 が最も高い優先度です。 既定値は 0 です。 |
| state | ジョブの現在の状態。 使用可能な値は、'active'、'disableding'、'disabled'、'enabling'、'terminating'、'completed'、'deleting' です。 |
| state |
ジョブが現在の状態になった時刻。 |
| stats | ジョブの有効期間全体のリソース使用状況の統計。 このプロパティは、CloudJob が 'stats' 属性を含む expand 句で取得された場合にのみ設定されます。それ以外の場合は null です。 統計をすぐに使用できない場合があります。 Batch サービスは、統計の定期的なロールアップを実行します。 一般的な遅延は約 30 分です。 |
| url | ジョブの URL。 |
| uses |
ジョブ内のタスクが相互に依存関係を定義できるかどうかを示します。 既定値は false です。 |
プロパティの詳細
commonEnvironmentSettings
一般的な環境変数設定の一覧。 これらの環境変数は、ジョブ内のすべてのタスク (ジョブ マネージャー、ジョブ準備タスク、ジョブ解放タスクを含む) に設定されます。 個々のタスクは、同じ設定名を別の値で指定することで、ここで指定した環境設定をオーバーライドできます。
commonEnvironmentSettings?: EnvironmentSetting[]プロパティ値
constraints
creationTime
ジョブの作成時刻。
creationTime?: Dateプロパティ値
Date
displayName
ジョブの表示名。
displayName?: stringプロパティ値
string
eTag
ジョブの ETag。 これは不透明な文字列です。 これを使用して、ジョブが要求間で変更されたかどうかを検出できます。 特に、ジョブを更新するときに ETag を渡して、その間に他の誰もジョブを変更していない場合にのみ変更を有効にするように指定できます。
eTag?: stringプロパティ値
string
executionInfo
id
アカウント内のジョブを一意に識別する文字列。 ID は大文字と小文字が区別されず、大文字と小文字が区別されません (つまり、アカウント内に大文字と小文字のみが異なる 2 つの ID がない可能性があります)。
id?: stringプロパティ値
string
jobManagerTask
jobPreparationTask
ジョブ準備タスク。 ジョブ準備タスクは、ジョブの他のタスクの前に各コンピューティング ノードで実行される特別なタスクです。
jobPreparationTask?: JobPreparationTaskプロパティ値
jobReleaseTask
ジョブ解放タスク。 ジョブ解放タスクは、ジョブの他のタスクを実行した各コンピューティング ノードで、ジョブの終了時に実行される特別なタスクです。
jobReleaseTask?: JobReleaseTaskプロパティ値
lastModified
ジョブの最終変更時刻。 これは、ジョブの状態や優先度など、ジョブ レベルのデータが最後に変更された時刻です。 新しいタスクの追加やタスクの状態の変更など、タスク レベルの変更は考慮されません。
lastModified?: Dateプロパティ値
Date
metadata
ジョブにメタデータとして関連付けられている名前と値のペアの一覧。 Batch サービスは、メタデータに意味を割り当てません。これは、ユーザー コードの使用のみを目的とします。
metadata?: MetadataItem[]プロパティ値
networkConfiguration
onAllTasksComplete
ジョブ内のすべてのタスクが完了状態のときに Batch サービスが実行する必要があるアクション。 既定値は noaction です。 指定できる値は、'noAction'、'terminateJob' です。
onAllTasksComplete?: OnAllTasksCompleteプロパティ値
onTaskFailure
ジョブ内のタスクが失敗したときに Batch サービスが実行する必要があるアクション。 failureInfo がある場合、タスクは失敗したと見なされます。 failureInfo は、再試行回数を使い果たした後にタスクが 0 以外の終了コードで完了した場合、またはリソース ファイルのダウンロード エラーが原因でタスクの開始エラーが発生した場合に設定されます。 既定値は noaction です。 指定できる値は、'noAction'、'performExitOptionsJobAction' です。
onTaskFailure?: OnTaskFailureプロパティ値
poolInfo
previousState
ジョブの以前の状態。 ジョブが初期アクティブ状態の場合、このプロパティは設定されません。 使用可能な値は、'active'、'disableding'、'disabled'、'enabling'、'terminating'、'completed'、'deleting' です。
previousState?: JobStateプロパティ値
previousStateTransitionTime
ジョブが以前の状態になった時刻。 ジョブが初期アクティブ状態の場合、このプロパティは設定されません。
previousStateTransitionTime?: Dateプロパティ値
Date
priority
ジョブの優先順位。 優先度の値の範囲は -1000 から 1000 までで、-1000 は最も低い優先度、1000 が最も高い優先度です。 既定値は 0 です。
priority?: numberプロパティ値
number
state
ジョブの現在の状態。 使用可能な値は、'active'、'disableding'、'disabled'、'enabling'、'terminating'、'completed'、'deleting' です。
state?: JobStateプロパティ値
stateTransitionTime
ジョブが現在の状態になった時刻。
stateTransitionTime?: Dateプロパティ値
Date
stats
ジョブの有効期間全体のリソース使用状況の統計。 このプロパティは、CloudJob が 'stats' 属性を含む expand 句で取得された場合にのみ設定されます。それ以外の場合は null です。 統計をすぐに使用できない場合があります。 Batch サービスは、統計の定期的なロールアップを実行します。 一般的な遅延は約 30 分です。
stats?: JobStatisticsプロパティ値
url
ジョブの URL。
url?: stringプロパティ値
string
usesTaskDependencies
ジョブ内のタスクが相互に依存関係を定義できるかどうかを示します。 既定値は false です。
usesTaskDependencies?: booleanプロパティ値
boolean