Task class
Task を表すクラス。
コンストラクター
| Task(Batch |
タスクを作成します。 |
メソッド
コンストラクターの詳細
Task(BatchServiceClientContext)
タスクを作成します。
new Task(client: BatchServiceClientContext)パラメーター
- client
- BatchServiceClientContext
サービス クライアントへの参照。
メソッドの詳細
add(string, TaskAddParameter, ServiceCallback<void>)
function add(jobId: string, task: TaskAddParameter, callback: ServiceCallback<void>)パラメーター
- jobId
-
string
タスクを追加するジョブの ID。
- task
- TaskAddParameter
追加するタスク。
- callback
-
ServiceCallback<void>
コールバック
add(string, TaskAddParameter, TaskAddOptionalParams)
タスクの追加から完了までの最大有効期間は 180 日です。 タスクが追加されてから 180 日以内に完了していない場合、そのタスクは Batch サービスによって終了され、その時点の状態のままになります。
function add(jobId: string, task: TaskAddParameter, options?: TaskAddOptionalParams): Promise<TaskAddResponse>パラメーター
- jobId
-
string
タスクを追加するジョブの ID。
- task
- TaskAddParameter
追加するタスク。
- options
- TaskAddOptionalParams
省略可能なパラメーター
戻り値
Promise<TaskAddResponse>
Promise<Models.TaskAddResponse応答>
add(string, TaskAddParameter, TaskAddOptionalParams, ServiceCallback<void>)
function add(jobId: string, task: TaskAddParameter, options: TaskAddOptionalParams, callback: ServiceCallback<void>)パラメーター
- jobId
-
string
タスクを追加するジョブの ID。
- task
- TaskAddParameter
追加するタスク。
- options
- TaskAddOptionalParams
省略可能なパラメーター
- callback
-
ServiceCallback<void>
コールバック
addCollection(string, TaskAddParameter[], ServiceCallback<TaskAddCollectionResult>)
function addCollection(jobId: string, value: TaskAddParameter[], callback: ServiceCallback<TaskAddCollectionResult>)パラメーター
- jobId
-
string
Task コレクションを追加するジョブの ID。
- value
追加するタスクのコレクション。 タスクの最大数は 100 です。 このコレクションのシリアル化された合計サイズは、1 MB 未満である必要があります。 1 MB を超える場合 (たとえば、各タスクに 100 のリソース ファイルまたは環境変数がある場合)、要求はコード 'RequestBodyTooLarge' で失敗し、タスク数を減らして再試行する必要があります。
- callback
コールバック
addCollection(string, TaskAddParameter[], TaskAddCollectionOptionalParams)
各タスクには一意の ID が必要です。 Batch サービスは、タスクがこの要求で送信されたのと同じ順序で各タスクの結果を返さない場合があります。 サーバーがタイムアウトになったり、要求中に接続が閉じられたりすると、要求が部分的または完全に処理されたか、まったく処理されていない可能性があります。 このような場合、ユーザーは要求を再発行する必要があります。 要求を再発行する際にエラーを正しく処理するのはユーザーが行う必要があることに注意してください。 たとえば、再試行中に同じタスク ID を使用して、前の操作が成功した場合、再試行によって予期しない追加のタスクが作成されないようにする必要があります。 応答に追加に失敗したタスクが含まれている場合、クライアントは要求を再試行できます。 再試行では、追加に失敗したタスクのみを再送信し、最初の試行で正常に追加されたタスクを省略するのが最も効率的です。 タスクの追加から完了までの最大有効期間は 180 日です。 タスクが追加されてから 180 日以内に完了していない場合、そのタスクは Batch サービスによって終了され、その時点の状態のままになります。
function addCollection(jobId: string, value: TaskAddParameter[], options?: TaskAddCollectionOptionalParams): Promise<TaskAddCollectionResponse>パラメーター
- jobId
-
string
Task コレクションを追加するジョブの ID。
- value
追加するタスクのコレクション。 タスクの最大数は 100 です。 このコレクションのシリアル化された合計サイズは、1 MB 未満である必要があります。 1 MB を超える場合 (たとえば、各タスクに 100 のリソース ファイルまたは環境変数がある場合)、要求はコード 'RequestBodyTooLarge' で失敗し、タスク数を減らして再試行する必要があります。
- options
- TaskAddCollectionOptionalParams
省略可能なパラメーター
戻り値
Promise<TaskAddCollectionResponse>
Promise<Models.TaskAddCollectionResponse応答>
addCollection(string, TaskAddParameter[], TaskAddCollectionOptionalParams, ServiceCallback<TaskAddCollectionResult>)
function addCollection(jobId: string, value: TaskAddParameter[], options: TaskAddCollectionOptionalParams, callback: ServiceCallback<TaskAddCollectionResult>)パラメーター
- jobId
-
string
Task コレクションを追加するジョブの ID。
- value
追加するタスクのコレクション。 タスクの最大数は 100 です。 このコレクションのシリアル化された合計サイズは、1 MB 未満である必要があります。 1 MB を超える場合 (たとえば、各タスクに 100 のリソース ファイルまたは環境変数がある場合)、要求はコード 'RequestBodyTooLarge' で失敗し、タスク数を減らして再試行する必要があります。
- options
- TaskAddCollectionOptionalParams
省略可能なパラメーター
- callback
コールバック
deleteMethod(string, string, ServiceCallback<void>)
function deleteMethod(jobId: string, taskId: string, callback: ServiceCallback<void>)パラメーター
- jobId
-
string
タスクを削除するジョブの ID。
- taskId
-
string
削除するタスクの ID。
- callback
-
ServiceCallback<void>
コールバック
deleteMethod(string, string, TaskDeleteMethodOptionalParams)
タスクが削除されると、実行されたコンピューティング ノード上のディレクトリ内のすべてのファイルも (保持時間に関係なく) 削除されます。 複数インスタンスのタスクの場合、タスクの削除操作はプライマリ タスクに同期的に適用されます。サブタスクとそのファイルは、バックグラウンドで非同期的に削除されます。
function deleteMethod(jobId: string, taskId: string, options?: TaskDeleteMethodOptionalParams): Promise<TaskDeleteResponse>パラメーター
- jobId
-
string
タスクを削除するジョブの ID。
- taskId
-
string
削除するタスクの ID。
- options
- TaskDeleteMethodOptionalParams
省略可能なパラメーター
戻り値
Promise<TaskDeleteResponse>
Promise<Models.TaskDeleteResponse応答>
deleteMethod(string, string, TaskDeleteMethodOptionalParams, ServiceCallback<void>)
function deleteMethod(jobId: string, taskId: string, options: TaskDeleteMethodOptionalParams, callback: ServiceCallback<void>)パラメーター
- jobId
-
string
タスクを削除するジョブの ID。
- taskId
-
string
削除するタスクの ID。
- options
- TaskDeleteMethodOptionalParams
省略可能なパラメーター
- callback
-
ServiceCallback<void>
コールバック
get(string, string, ServiceCallback<CloudTask>)
function get(jobId: string, taskId: string, callback: ServiceCallback<CloudTask>)パラメーター
- jobId
-
string
タスクを含むジョブの ID。
- taskId
-
string
情報を取得するタスクの ID。
- callback
コールバック
get(string, string, TaskGetOptionalParams)
複数インスタンスのタスクの場合、affinityId、executionInfo、nodeInfo などの情報は、プライマリ タスクを参照します。 サブタスクの一覧 API を使用して、サブタスクに関する情報を取得します。
function get(jobId: string, taskId: string, options?: TaskGetOptionalParams): Promise<TaskGetResponse>パラメーター
- jobId
-
string
タスクを含むジョブの ID。
- taskId
-
string
情報を取得するタスクの ID。
- options
- TaskGetOptionalParams
省略可能なパラメーター
戻り値
Promise<TaskGetResponse>
Promise<Models.TaskGetResponse>
get(string, string, TaskGetOptionalParams, ServiceCallback<CloudTask>)
function get(jobId: string, taskId: string, options: TaskGetOptionalParams, callback: ServiceCallback<CloudTask>)パラメーター
- jobId
-
string
タスクを含むジョブの ID。
- taskId
-
string
情報を取得するタスクの ID。
- options
- TaskGetOptionalParams
省略可能なパラメーター
- callback
コールバック
list(string, ServiceCallback<CloudTaskListResult>)
function list(jobId: string, callback: ServiceCallback<CloudTaskListResult>)パラメーター
- jobId
-
string
ジョブの ID。
- callback
コールバック
list(string, TaskListOptionalParams)
複数インスタンスのタスクの場合、affinityId、executionInfo、nodeInfo などの情報は、プライマリ タスクを参照します。 サブタスクの一覧 API を使用して、サブタスクに関する情報を取得します。
function list(jobId: string, options?: TaskListOptionalParams): Promise<TaskListResponse>パラメーター
- jobId
-
string
ジョブの ID。
- options
- TaskListOptionalParams
省略可能なパラメーター
戻り値
Promise<TaskListResponse>
Promise<Models.TaskListResponse応答>
list(string, TaskListOptionalParams, ServiceCallback<CloudTaskListResult>)
function list(jobId: string, options: TaskListOptionalParams, callback: ServiceCallback<CloudTaskListResult>)パラメーター
- jobId
-
string
ジョブの ID。
- options
- TaskListOptionalParams
省略可能なパラメーター
- callback
コールバック
listNext(string, ServiceCallback<CloudTaskListResult>)
function listNext(nextPageLink: string, callback: ServiceCallback<CloudTaskListResult>)パラメーター
- nextPageLink
-
string
List 操作に対する前回の正常な呼び出しからの NextLink。
- callback
コールバック
listNext(string, TaskListNextOptionalParams)
複数インスタンスのタスクの場合、affinityId、executionInfo、nodeInfo などの情報は、プライマリ タスクを参照します。 サブタスクの一覧 API を使用して、サブタスクに関する情報を取得します。
function listNext(nextPageLink: string, options?: TaskListNextOptionalParams): Promise<TaskListResponse>パラメーター
- nextPageLink
-
string
List 操作に対する前回の正常な呼び出しからの NextLink。
- options
- TaskListNextOptionalParams
省略可能なパラメーター
戻り値
Promise<TaskListResponse>
Promise<Models.TaskListResponse応答>
listNext(string, TaskListNextOptionalParams, ServiceCallback<CloudTaskListResult>)
function listNext(nextPageLink: string, options: TaskListNextOptionalParams, callback: ServiceCallback<CloudTaskListResult>)パラメーター
- nextPageLink
-
string
List 操作に対する前回の正常な呼び出しからの NextLink。
- options
- TaskListNextOptionalParams
省略可能なパラメーター
- callback
コールバック
listSubtasks(string, string, ServiceCallback<CloudTaskListSubtasksResult>)
function listSubtasks(jobId: string, taskId: string, callback: ServiceCallback<CloudTaskListSubtasksResult>)パラメーター
- jobId
-
string
ジョブの ID。
- taskId
-
string
タスクの ID。
- callback
コールバック
listSubtasks(string, string, TaskListSubtasksOptionalParams)
Task が複数インスタンスのタスクでない場合は、空のコレクションが返されます。
function listSubtasks(jobId: string, taskId: string, options?: TaskListSubtasksOptionalParams): Promise<TaskListSubtasksResponse>パラメーター
- jobId
-
string
ジョブの ID。
- taskId
-
string
タスクの ID。
- options
- TaskListSubtasksOptionalParams
省略可能なパラメーター
戻り値
Promise<TaskListSubtasksResponse>
Promise<Models.TaskListSubtasksResponse>
listSubtasks(string, string, TaskListSubtasksOptionalParams, ServiceCallback<CloudTaskListSubtasksResult>)
function listSubtasks(jobId: string, taskId: string, options: TaskListSubtasksOptionalParams, callback: ServiceCallback<CloudTaskListSubtasksResult>)パラメーター
- jobId
-
string
ジョブの ID。
- taskId
-
string
タスクの ID。
- options
- TaskListSubtasksOptionalParams
省略可能なパラメーター
- callback
コールバック
reactivate(string, string, ServiceCallback<void>)
function reactivate(jobId: string, taskId: string, callback: ServiceCallback<void>)パラメーター
- jobId
-
string
タスクを含むジョブの ID。
- taskId
-
string
再アクティブ化するタスクの ID。
- callback
-
ServiceCallback<void>
コールバック
reactivate(string, string, TaskReactivateOptionalParams)
再アクティブ化すると、タスクは最大再試行回数まで再試行できるようになります。 タスクの状態がアクティブに変更されます。 タスクが完了状態ではなくなったので、以前の終了コードまたはエラー情報は、再アクティブ化後に使用できなくなります。 タスクが再アクティブ化されるたびに、再試行回数は 0 にリセットされます。 完了していないタスクまたは以前に正常に完了したタスク (終了コード 0) の場合、再アクティブ化は失敗します。 さらに、ジョブが完了した (または終了または削除中) 場合は失敗します。
function reactivate(jobId: string, taskId: string, options?: TaskReactivateOptionalParams): Promise<TaskReactivateResponse>パラメーター
- jobId
-
string
タスクを含むジョブの ID。
- taskId
-
string
再アクティブ化するタスクの ID。
- options
- TaskReactivateOptionalParams
省略可能なパラメーター
戻り値
Promise<TaskReactivateResponse>
Promise<Models.TaskReactivateResponse>
reactivate(string, string, TaskReactivateOptionalParams, ServiceCallback<void>)
function reactivate(jobId: string, taskId: string, options: TaskReactivateOptionalParams, callback: ServiceCallback<void>)パラメーター
- jobId
-
string
タスクを含むジョブの ID。
- taskId
-
string
再アクティブ化するタスクの ID。
- options
- TaskReactivateOptionalParams
省略可能なパラメーター
- callback
-
ServiceCallback<void>
コールバック
terminate(string, string, ServiceCallback<void>)
function terminate(jobId: string, taskId: string, callback: ServiceCallback<void>)パラメーター
- jobId
-
string
タスクを含むジョブの ID。
- taskId
-
string
終了するタスクの ID。
- callback
-
ServiceCallback<void>
コールバック
terminate(string, string, TaskTerminateOptionalParams)
タスクが終了すると、完了状態に移動します。 複数インスタンスのタスクの場合、終了タスク操作はプライマリ タスクに同期的に適用されます。その後、サブタスクはバックグラウンドで非同期的に終了します。
function terminate(jobId: string, taskId: string, options?: TaskTerminateOptionalParams): Promise<TaskTerminateResponse>パラメーター
- jobId
-
string
タスクを含むジョブの ID。
- taskId
-
string
終了するタスクの ID。
- options
- TaskTerminateOptionalParams
省略可能なパラメーター
戻り値
Promise<TaskTerminateResponse>
Promise<Models.TaskTerminateResponse応答>
terminate(string, string, TaskTerminateOptionalParams, ServiceCallback<void>)
function terminate(jobId: string, taskId: string, options: TaskTerminateOptionalParams, callback: ServiceCallback<void>)パラメーター
- jobId
-
string
タスクを含むジョブの ID。
- taskId
-
string
終了するタスクの ID。
- options
- TaskTerminateOptionalParams
省略可能なパラメーター
- callback
-
ServiceCallback<void>
コールバック
update(string, string, ServiceCallback<void>)
function update(jobId: string, taskId: string, callback: ServiceCallback<void>)パラメーター
- jobId
-
string
タスクを含むジョブの ID。
- taskId
-
string
更新するタスクの ID。
- callback
-
ServiceCallback<void>
コールバック
update(string, string, TaskUpdateOptionalParams)
指定したタスクのプロパティを更新します。
function update(jobId: string, taskId: string, options?: TaskUpdateOptionalParams): Promise<TaskUpdateResponse>パラメーター
- jobId
-
string
タスクを含むジョブの ID。
- taskId
-
string
更新するタスクの ID。
- options
- TaskUpdateOptionalParams
省略可能なパラメーター
戻り値
Promise<TaskUpdateResponse>
Promise<Models.TaskUpdateResponse応答>
update(string, string, TaskUpdateOptionalParams, ServiceCallback<void>)
function update(jobId: string, taskId: string, options: TaskUpdateOptionalParams, callback: ServiceCallback<void>)パラメーター
- jobId
-
string
タスクを含むジョブの ID。
- taskId
-
string
更新するタスクの ID。
- options
- TaskUpdateOptionalParams
省略可能なパラメーター
- callback
-
ServiceCallback<void>
コールバック