JobUpdateParameter クラス
ジョブに対して行う一連の変更。
Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
- 継承
-
JobUpdateParameter
コンストラクター
JobUpdateParameter(*, pool_info, priority: int = None, max_parallel_tasks: int = -1, allow_task_preemption: bool = None, constraints=None, metadata=None, on_all_tasks_complete=None, **kwargs)パラメーター
- priority
- int
ジョブの優先度。 優先度の値の範囲は -1000 から 1000 です。-1000 が最も低い優先度で、1000 が最高の優先度です。 省略すると、既定値は 0 に設定されます。
- max_parallel_tasks
- int
ジョブに対して並列で実行できるタスクの最大数。 maxParallelTasks の値は、-1 または指定した場合は 0 より大きくする必要があります。 指定しない場合、既定値は -1 です。つまり、一度に実行できるタスクの数に制限はありません。 ジョブの maxParallelTasks は、更新ジョブ API を使用して作成した後で更新できます。 既定値: -1。
- allow_task_preemption
- bool
このジョブのタスクを他の優先度の高いジョブに割り込むことができるかどうか。 値が True に設定されている場合、システムに送信された他の優先度の高いジョブが優先され、このジョブからタスクを再キューできます。 ジョブの allowTaskPreemption は、更新ジョブ API を使用して作成した後で更新できます。
- pool_info
- PoolInformation
必須。 Batch サービスがジョブのタスクを実行するプール。 ジョブのプールは、ジョブが無効になっている場合にのみ変更できます。 poolInfo 要素を含め、ジョブが無効でない場合、Update Job 呼び出しは失敗します。 poolInfo で autoPoolSpecification を指定した場合は、autoPoolSpecification の keepAlive プロパティのみを更新し、autoPoolSpecification に job の poolLifetimeOption がある場合にのみ更新できます (他のジョブ プロパティは通常どおりに更新できます)。
- on_all_tasks_complete
- str または OnAllTasksComplete
ジョブ内のすべてのタスクが完了状態の場合に Batch サービスが実行する必要があるアクション。 省略すると、完了動作は noaction に設定されます。 現在の値が terminatejob の場合、ジョブの完了動作が terminatejob から noaction に変更されない可能性があるため、これはエラーです。 値を terminatejob から noaction に変更することはできません。つまり、ジョブの自動終了を実行した後は、もう一度オフにすることはできません。 これを行おうとすると、要求は失敗し、Batch は状態コード 400 (無効な要求) と "無効なプロパティ値" エラー応答を返します。 PUT 要求でこの要素を指定しない場合、noaction を渡すのと同じです。 現在の値が terminatejob の場合、これはエラーです。 使用できる値は、'noAction'、'terminateJob' です。
メソッド
| 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