SubtaskInformation interface

パッケージ:

@azure/batch

SubtaskInformation を表すインターフェイス。

プロパティ

containerInfo	タスクが実行されているコンテナーに関する情報。 このプロパティは、タスクがコンテナー コンテキストで実行される場合にのみ設定されます。
endTime	サブタスクが完了した時刻。 このプロパティは、サブタスクが Completed 状態の場合にのみ設定されます。
exitCode	サブタスク・コマンド・ラインで指定されたプログラムの終了コード。 このプロパティは、サブタスクが完了状態の場合にのみ設定されます。 一般に、プロセスの終了コードには、そのプロセスに対してアプリケーション開発者によって実装された特定の規則が反映されます。 終了コード値を使用してコード内で決定を行う場合は、アプリケーション プロセスで使用される終了コード規則がわかっていることを確認してください。 ただし、Batch サービスがサブタスクを終了した場合 (タイムアウトのため、または API 経由でユーザーが終了した場合)、オペレーティング システムで定義された終了コードが表示されることがあります。
failureInfo	タスクの失敗を説明する情報 (存在する場合)。 このプロパティは、Task が完了状態でエラーが発生した場合にのみ設定されます。
id	サブタスクの ID。
nodeInfo	サブタスクが実行されたコンピューティング ノードに関する情報。
previousState	サブタスクの以前の状態。 サブタスクが初期状態の場合、このプロパティは設定されません。 使用可能な値は、"準備中"、"実行中"、"完了" です。
previousStateTransitionTime	サブタスクが以前の状態になった時刻。 サブタスクが初期状態の場合、このプロパティは設定されません。
result	タスク実行の結果。 値が 'failed' の場合は、failureInfo プロパティでエラーの詳細を確認できます。 使用可能な値は、'success'、'failure' です。
startTime	サブタスクの実行を開始した時刻。 サブタスクが再起動または再試行された場合、これはサブタスクの実行を開始した最新の時刻です。
state	サブタスクの現在の状態。 使用可能な値は、"準備中"、"実行中"、"完了" です。
stateTransitionTime	サブタスクが現在の状態になった時刻。

プロパティの詳細

containerInfo

タスクが実行されているコンテナーに関する情報。 このプロパティは、タスクがコンテナー コンテキストで実行される場合にのみ設定されます。

containerInfo?: TaskContainerExecutionInformation

プロパティ値

TaskContainerExecutionInformation

endTime

サブタスクが完了した時刻。 このプロパティは、サブタスクが Completed 状態の場合にのみ設定されます。

endTime?: Date

プロパティ値

Date

exitCode

サブタスク・コマンド・ラインで指定されたプログラムの終了コード。 このプロパティは、サブタスクが完了状態の場合にのみ設定されます。 一般に、プロセスの終了コードには、そのプロセスに対してアプリケーション開発者によって実装された特定の規則が反映されます。 終了コード値を使用してコード内で決定を行う場合は、アプリケーション プロセスで使用される終了コード規則がわかっていることを確認してください。 ただし、Batch サービスがサブタスクを終了した場合 (タイムアウトのため、または API 経由でユーザーが終了した場合)、オペレーティング システムで定義された終了コードが表示されることがあります。

exitCode?: number

プロパティ値

number

failureInfo

タスクの失敗を説明する情報 (存在する場合)。 このプロパティは、Task が完了状態でエラーが発生した場合にのみ設定されます。

failureInfo?: TaskFailureInformation

プロパティ値

TaskFailureInformation

id

サブタスクの ID。

id?: number

プロパティ値

number

nodeInfo

サブタスクが実行されたコンピューティング ノードに関する情報。

nodeInfo?: ComputeNodeInformation

プロパティ値

ComputeNodeInformation

previousState

サブタスクの以前の状態。 サブタスクが初期状態の場合、このプロパティは設定されません。 使用可能な値は、"準備中"、"実行中"、"完了" です。

previousState?: SubtaskState

プロパティ値

SubtaskState

previousStateTransitionTime

サブタスクが以前の状態になった時刻。 サブタスクが初期状態の場合、このプロパティは設定されません。

previousStateTransitionTime?: Date

プロパティ値

Date

result

タスク実行の結果。 値が 'failed' の場合は、failureInfo プロパティでエラーの詳細を確認できます。 使用可能な値は、'success'、'failure' です。

result?: TaskExecutionResult

プロパティ値

TaskExecutionResult

startTime

サブタスクの実行を開始した時刻。 サブタスクが再起動または再試行された場合、これはサブタスクの実行を開始した最新の時刻です。

startTime?: Date

プロパティ値

Date

state

サブタスクの現在の状態。 使用可能な値は、"準備中"、"実行中"、"完了" です。

state?: SubtaskState

プロパティ値

SubtaskState

stateTransitionTime

サブタスクが現在の状態になった時刻。

stateTransitionTime?: Date

プロパティ値

Date