JobAddParameter クラス
追加するAzure Batch ジョブ。
Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
- 継承
-
JobAddParameter
コンストラクター
JobAddParameter(*, id: str, pool_info, display_name: str = None, priority: int = None, max_parallel_tasks: int = -1, allow_task_preemption: bool = None, constraints=None, job_manager_task=None, job_preparation_task=None, job_release_task=None, common_environment_settings=None, on_all_tasks_complete=None, on_task_failure=None, metadata=None, uses_task_dependencies: bool = None, network_configuration=None, **kwargs)パラメーター
- id
- str
必須。 ID には、ハイフンとアンダースコアを含む英数字の任意の組み合わせを含めることができます。また、64 文字を超えることはできません。 ID では、大文字と小文字が区別されず、大文字と小文字が区別されません (つまり、アカウント内に大文字と小文字のみが異なる 2 つの ID を持っていない可能性があります)。
- max_parallel_tasks
- int
ジョブに対して並列で実行できるタスクの最大数。 maxParallelTasks の値は、-1 または指定した場合は 0 より大きくする必要があります。 指定しない場合、既定値は -1 です。つまり、一度に実行できるタスクの数に制限はありません。 ジョブの maxParallelTasks は、更新ジョブ API を使用して作成した後で更新できます。 既定値: -1。
- allow_task_preemption
- bool
このジョブのタスクを他の優先度の高いジョブに割り込むことができるかどうか。 値が True に設定されている場合、システムに送信された他の優先度の高いジョブが優先され、このジョブからタスクを再キューできます。 ジョブの allowTaskPreemption は、更新ジョブ API を使用して作成した後で更新できます。
- job_manager_task
- JobManagerTask
ジョブの開始時に起動されるジョブ マネージャー タスクの詳細。 ジョブでジョブ マネージャー タスクが指定されていない場合、ユーザーはジョブにタスクを明示的に追加する必要があります。 ジョブでジョブ マネージャー タスクが指定されている場合、Batch サービスはジョブの作成時にジョブ マネージャー タスクを作成し、ジョブ内の他のタスクをスケジュールする前にジョブ マネージャー タスクのスケジュールを設定しようとします。 ジョブ マネージャー タスクの一般的な目的は、ジョブの実行を制御または監視することです。たとえば、実行する追加のタスクの決定、作業の完了時期の決定などです。(ただし、ジョブ マネージャー タスクはこれらのアクティビティに限定されるのではなく、システム内の本格的なタスクであり、ジョブに必要なアクションを実行します)。たとえば、ジョブ マネージャー タスクでは、パラメーターとして指定されたファイルをダウンロードし、そのファイルの内容を分析し、それらの内容に基づいて追加のタスクを送信できます。
- job_preparation_task
- JobPreparationTask
ジョブ準備タスク。 ジョブにジョブ準備タスクがある場合、Batch サービスはノードでジョブ準備タスクを実行してから、そのコンピューティング ノードでそのジョブのタスクを開始します。
- job_release_task
- JobReleaseTask
ジョブ解放タスク。 ジョブのジョブ解放タスクは、ジョブのジョブ準備タスクも指定しないと指定できません。 Batch サービスは、ジョブ準備タスクを実行したノードでジョブ解放タスクを実行します。 ジョブ解放タスクの主な目的は、ジョブ準備タスクによって行われたコンピューティング ノードの変更を元に戻すことです。 アクティビティの例としては、ローカル ファイルの削除、ジョブ準備の一環として開始されたサービスのシャットダウンなどがあります。
- common_environment_settings
- list[EnvironmentSetting]
個々のタスクは、同じ設定名を別の値で指定することで、ここで指定した環境設定をオーバーライドできます。
- on_all_tasks_complete
- str または OnAllTasksComplete
ジョブ内のすべてのタスクが完了状態の場合に Batch サービスが実行する必要があるアクション。 ジョブにタスクが含まれない場合、すべてのタスクは完了と見なされることに注意してください。 したがって、このオプションは、ジョブ マネージャー タスクで最もよく使用されます。ジョブ マネージャーを使用せずにジョブの自動終了を使用する場合は、最初に onAllTasksComplete を noaction に設定し、タスクの追加が完了したらジョブを終了するように onAllTasksComplete に設定するように Job プロパティを更新する必要があります。 既定値は noaction です。 使用できる値は、'noAction'、'terminateJob' です。
- on_task_failure
- str または OnTaskFailure
ジョブ内のタスクが失敗したときに Batch サービスが実行する必要があるアクション。 task が failureInfo を持っている場合、タスクは失敗したと見なされます。 failureInfo は、再試行回数を使い果たした後にタスクが 0 以外の終了コードで完了した場合、またはリソース ファイルのダウンロード エラーなどの原因でタスクを開始中にエラーが発生した場合に設定されます。 既定値は noaction です。 使用できる値は、'noAction'、'performExitOptionsJobAction' です。
メソッド
| as_dict |
json.dump を使用して JSONify できる dict を返します。 高度な使用法では、必要に応じてコールバックをパラメーターとして使用できます。 キーは、Python で使用される属性名です。 Attr_descはメタデータのディクテーションです。 現在、msrest 型の 'type' と RestAPI でエンコードされたキーを持つ 'key' が含まれています。 値は、このオブジェクトの現在の値です。 返される文字列は、キーのシリアル化に使用されます。 戻り値の型がリストの場合、これは階層的な結果 dict と見なされます。 このファイルの 3 つの例を参照してください。
XML シリアル化が必要な場合は、kwargs is_xml=True を渡すことができます。 |
| deserialize |
RestAPI 構文を使用して str を解析し、モデルを返します。 |
| enable_additional_properties_sending | |
| from_dict |
指定されたキー抽出器を使用してディクテーションを解析し、モデルを返します。 既定では、キー抽出器 (rest_key_case_insensitive_extractor、attribute_key_case_insensitive_extractor、last_rest_key_case_insensitive_extractor) を検討してください |
| is_xml_model | |
| serialize |
このモデルから Azure に送信される JSON を返します。 これは、 as_dict(full_restapi_key_transformer、keep_readonly=False) のエイリアスです。 XML シリアル化が必要な場合は、kwargs is_xml=True を渡すことができます。 |
| validate |
このモデルを再帰的に検証し、ValidationError の一覧を返します。 |
as_dict
json.dump を使用して JSONify できる dict を返します。
高度な使用法では、必要に応じてコールバックをパラメーターとして使用できます。
キーは、Python で使用される属性名です。 Attr_descはメタデータのディクテーションです。 現在、msrest 型の 'type' と RestAPI でエンコードされたキーを持つ 'key' が含まれています。 値は、このオブジェクトの現在の値です。
返される文字列は、キーのシリアル化に使用されます。 戻り値の型がリストの場合、これは階層的な結果 dict と見なされます。
このファイルの 3 つの例を参照してください。
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
XML シリアル化が必要な場合は、kwargs is_xml=True を渡すことができます。
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)パラメーター
- key_transformer
- <xref:function>
キー トランスフォーマー関数。
- keep_readonly
戻り値
dict JSON 互換オブジェクト
の戻り値の型 :
deserialize
RestAPI 構文を使用して str を解析し、モデルを返します。
deserialize(data, content_type=None)パラメーター
戻り値
このモデルのインスタンス
例外
enable_additional_properties_sending
enable_additional_properties_sending()from_dict
指定されたキー抽出器を使用してディクテーションを解析し、モデルを返します。
既定では、キー抽出器 (rest_key_case_insensitive_extractor、attribute_key_case_insensitive_extractor、last_rest_key_case_insensitive_extractor) を検討してください
from_dict(data, key_extractors=None, content_type=None)パラメーター
- key_extractors
戻り値
このモデルのインスタンス
例外
is_xml_model
is_xml_model()serialize
このモデルから Azure に送信される JSON を返します。
これは、 as_dict(full_restapi_key_transformer、keep_readonly=False) のエイリアスです。
XML シリアル化が必要な場合は、kwargs is_xml=True を渡すことができます。
serialize(keep_readonly=False, **kwargs)パラメーター
戻り値
dict JSON 互換オブジェクト
の戻り値の型 :
validate
Azure SDK for Python