TaskOperations クラス
TaskOperations 操作。
このクラスを直接インスタンス化するのではなく、クライアント インスタンスを作成して属性としてアタッチします。
- 継承
-
builtins.objectTaskOperations
コンストラクター
TaskOperations(client, config, serializer, deserializer)パラメーター
- client
サービス要求のクライアント。
- config
サービス クライアントの構成。
- serializer
オブジェクト モデル シリアライザー。
- deserializer
オブジェクト モデル逆シリアライザー。
変数
- api_version
要求で使用する API のバージョン。 定数値: "2023-05-01.17.0"
メソッド
| add |
指定したジョブに Task を追加します。 タスクの追加から完了までの最大有効期間は 180 日です。 タスクが追加されてから 180 日以内に完了していない場合、そのタスクは Batch サービスによって終了され、その時点の状態のままになります。 |
| add_collection |
指定したジョブにタスクのコレクションを追加します。 各タスクには一意の ID が必要です。 Batch サービスは、タスクがこの要求で送信されたのと同じ順序で各タスクの結果を返さない場合があります。 サーバーがタイムアウトした場合、または要求中に接続が閉じている場合は、要求が部分的または完全に処理されたか、まったく処理されていない可能性があります。 このような場合、ユーザーは要求を再実行する必要があります。 要求を再発行する際にエラーを正しく処理するのはユーザーが行う必要があることに注意してください。 たとえば、再試行中に同じタスク ID を使用して、前の操作が成功した場合、再試行によって予期しない追加のタスクが作成されないようにする必要があります。 応答に追加に失敗したタスクが含まれている場合、クライアントは要求を再試行できます。 再試行では、追加に失敗したタスクのみを再送信し、最初の試行で正常に追加されたタスクを省略するのが最も効率的です。 タスクの追加から完了までの最大有効期間は 180 日です。 タスクが追加されてから 180 日以内に完了していない場合、そのタスクは Batch サービスによって終了され、その時点の状態のままになります。 |
| delete |
指定したジョブからタスクを削除します。 タスクが削除されると、実行されたコンピューティング ノード上のディレクトリ内のすべてのファイルも削除されます (保持時間に関係なく)。 複数インスタンスのタスクの場合、タスクの削除操作はプライマリ タスクに同期的に適用されます。サブタスクとそのファイルは、バックグラウンドで非同期的に削除されます。 |
| get |
指定した Task に関する情報を取得します。 複数インスタンスのタスクの場合、affinityId、executionInfo、nodeInfo などの情報は、プライマリ タスクを参照してください。 サブタスクの一覧 API を使用して、サブタスクに関する情報を取得します。 |
| list |
指定したジョブに関連付けられているすべてのタスクを一覧表示します。 複数インスタンスのタスクの場合、affinityId、executionInfo、nodeInfo などの情報は、プライマリ タスクを参照してください。 サブタスクの一覧 API を使用して、サブタスクに関する情報を取得します。 |
| list_subtasks |
指定したマルチインスタンス タスクに関連付けられているすべてのサブタスクを一覧表示します。 Task が複数インスタンスの Task でない場合、空のコレクションが返されます。 |
| reactivate |
タスクを再アクティブ化し、再試行回数が不足している場合でも再度実行できるようにします。 再アクティブ化すると、タスクは最大再試行回数まで再試行できるようになります。 タスクの状態がアクティブに変更されます。 タスクが完了状態ではなくなったので、再アクティブ化後、以前の終了コードまたはエラー情報は使用できなくなります。 タスクが再アクティブ化されるたびに、再試行回数は 0 にリセットされます。 完了していないタスクまたは以前に正常に完了したタスク (終了コード 0) の場合、再アクティブ化は失敗します。 さらに、ジョブが完了した (または終了または削除中) 場合は失敗します。 |
| terminate |
指定した Task を終了します。 タスクが終了すると、完了した状態に移動します。 複数インスタンスのタスクの場合、終了タスク操作はプライマリ タスクに同期的に適用されます。その後、サブタスクはバックグラウンドで非同期的に終了します。 |
| update |
指定した Task のプロパティを更新します。 |
add
指定したジョブに Task を追加します。
タスクの追加から完了までの最大有効期間は 180 日です。 タスクが追加されてから 180 日以内に完了していない場合、そのタスクは Batch サービスによって終了され、その時点の状態のままになります。
add(job_id, task, task_add_options=None, custom_headers=None, raw=False, **operation_config)パラメーター
- operation_config
操作構成のオーバーライド。
戻り値
none または ClientRawResponse (raw=true の場合)
の戻り値の型 :
例外
add_collection
指定したジョブにタスクのコレクションを追加します。
各タスクには一意の ID が必要です。 Batch サービスは、タスクがこの要求で送信されたのと同じ順序で各タスクの結果を返さない場合があります。 サーバーがタイムアウトした場合、または要求中に接続が閉じている場合は、要求が部分的または完全に処理されたか、まったく処理されていない可能性があります。 このような場合、ユーザーは要求を再実行する必要があります。 要求を再発行する際にエラーを正しく処理するのはユーザーが行う必要があることに注意してください。 たとえば、再試行中に同じタスク ID を使用して、前の操作が成功した場合、再試行によって予期しない追加のタスクが作成されないようにする必要があります。 応答に追加に失敗したタスクが含まれている場合、クライアントは要求を再試行できます。 再試行では、追加に失敗したタスクのみを再送信し、最初の試行で正常に追加されたタスクを省略するのが最も効率的です。 タスクの追加から完了までの最大有効期間は 180 日です。 タスクが追加されてから 180 日以内に完了していない場合、そのタスクは Batch サービスによって終了され、その時点の状態のままになります。
add_collection(job_id, value, task_add_collection_options=None, custom_headers=None, raw=False, threads=0, **operation_config)パラメーター
- value
- list of TaskAddParameter
追加するタスクのコレクション。 このコレクションのシリアル化された合計サイズは 4 MB 未満である必要があります。 4 MB を超える場合 (たとえば、各タスクに 100 個のリソース ファイルまたは環境変数がある場合)、要求はコード 'RequestBodyTooLarge' で失敗し、少ないタスクで再試行する必要があります。
- threads
- int
タスクを追加するときに並列で使用するスレッドの数。 を指定し、0 より大きい場合、要求を送信して完了するまで待機するために、追加のスレッドが開始されます。 それ以外の場合は、メイン スレッドでadd_collection要求を順次送信します
戻り値
TaskAddCollectionResult または ClientRawResponse raw=true の場合
の戻り値の型 :
例外
delete
指定したジョブからタスクを削除します。
タスクが削除されると、実行されたコンピューティング ノード上のディレクトリ内のすべてのファイルも削除されます (保持時間に関係なく)。 複数インスタンスのタスクの場合、タスクの削除操作はプライマリ タスクに同期的に適用されます。サブタスクとそのファイルは、バックグラウンドで非同期的に削除されます。
delete(job_id, task_id, task_delete_options=None, custom_headers=None, raw=False, **operation_config)パラメーター
- operation_config
操作構成のオーバーライド。
戻り値
none または ClientRawResponse (raw=true の場合)
の戻り値の型 :
例外
get
指定した Task に関する情報を取得します。
複数インスタンスのタスクの場合、affinityId、executionInfo、nodeInfo などの情報は、プライマリ タスクを参照してください。 サブタスクの一覧 API を使用して、サブタスクに関する情報を取得します。
get(job_id, task_id, task_get_options=None, custom_headers=None, raw=False, **operation_config)パラメーター
- operation_config
操作構成のオーバーライド。
戻り値
CloudTask または ClientRawResponse (raw=true の場合)
の戻り値の型 :
例外
list
指定したジョブに関連付けられているすべてのタスクを一覧表示します。
複数インスタンスのタスクの場合、affinityId、executionInfo、nodeInfo などの情報は、プライマリ タスクを参照してください。 サブタスクの一覧 API を使用して、サブタスクに関する情報を取得します。
list(job_id, task_list_options=None, custom_headers=None, raw=False, **operation_config)パラメーター
- operation_config
操作構成のオーバーライド。
戻り値
CloudTask のインスタンスのような反復子
の戻り値の型 :
例外
list_subtasks
指定したマルチインスタンス タスクに関連付けられているすべてのサブタスクを一覧表示します。
Task が複数インスタンスの Task でない場合、空のコレクションが返されます。
list_subtasks(job_id, task_id, task_list_subtasks_options=None, custom_headers=None, raw=False, **operation_config)パラメーター
- operation_config
操作構成のオーバーライド。
戻り値
cloudTaskListSubtasksResult または ClientRawResponse (raw=true の場合)
の戻り値の型 :
例外
reactivate
タスクを再アクティブ化し、再試行回数が不足している場合でも再度実行できるようにします。
再アクティブ化すると、タスクは最大再試行回数まで再試行できるようになります。 タスクの状態がアクティブに変更されます。 タスクが完了状態ではなくなったので、再アクティブ化後、以前の終了コードまたはエラー情報は使用できなくなります。 タスクが再アクティブ化されるたびに、再試行回数は 0 にリセットされます。 完了していないタスクまたは以前に正常に完了したタスク (終了コード 0) の場合、再アクティブ化は失敗します。 さらに、ジョブが完了した (または終了または削除中) 場合は失敗します。
reactivate(job_id, task_id, task_reactivate_options=None, custom_headers=None, raw=False, **operation_config)パラメーター
- operation_config
操作構成のオーバーライド。
戻り値
none または ClientRawResponse (raw=true の場合)
の戻り値の型 :
例外
terminate
指定した Task を終了します。
タスクが終了すると、完了した状態に移動します。 複数インスタンスのタスクの場合、終了タスク操作はプライマリ タスクに同期的に適用されます。その後、サブタスクはバックグラウンドで非同期的に終了します。
terminate(job_id, task_id, task_terminate_options=None, custom_headers=None, raw=False, **operation_config)パラメーター
- operation_config
操作構成のオーバーライド。
戻り値
none または ClientRawResponse (raw=true の場合)
の戻り値の型 :
例外
update
指定した Task のプロパティを更新します。
update(job_id, task_id, constraints=None, task_update_options=None, custom_headers=None, raw=False, **operation_config)パラメーター
- constraints
- TaskConstraints
このタスクに適用される制約。 省略した場合、Task には既定の制約が与えられます。 複数インスタンスのタスクの場合、保持時間の更新はプライマリ タスクにのみ適用され、サブタスクには適用されません。
- operation_config
操作の構成がオーバーライドされます。
戻り値
raw=true の場合は None または ClientRawResponse
の戻り値の型 :
例外
属性
models
models = <module 'azure.batch.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.7\\x64\\Lib\\site-packages\\azure\\batch\\models\\__init__.py'>
Azure SDK for Python