CloudJob クラス

  • リファレンス

Azure Batch ジョブ。

継承
Model
CloudJob

コンストラクター

CloudJob(*, id: str = None, display_name: str = None, uses_task_dependencies: bool = None, url: str = None, e_tag: str = None, last_modified=None, creation_time=None, state=None, state_transition_time=None, previous_state=None, previous_state_transition_time=None, priority: int = None, allow_task_preemption: bool = None, max_parallel_tasks: int = -1, constraints=None, job_manager_task=None, job_preparation_task=None, job_release_task=None, common_environment_settings=None, pool_info=None, on_all_tasks_complete=None, on_task_failure=None, network_configuration=None, metadata=None, execution_info=None, stats=None, **kwargs)

パラメーター

id
str
必須

ID は大文字と小文字が区別されず、大文字と小文字が区別されません (つまり、アカウント内に大文字と小文字のみが異なる 2 つの ID がない可能性があります)。

display_name
str
必須
uses_task_dependencies
bool
必須

ジョブ内のタスクが相互に依存関係を定義できるかどうか。 既定値は false です。

url
str
必須
e_tag
str
必須

これは不透明な文字列です。 これを使用して、要求間でジョブが変更されたかどうかを検出できます。 特に、ジョブを更新するときに ETag を渡して、その間に他のユーザーがジョブを変更していない場合にのみ変更を有効にするように指定できます。

last_modified
datetime
必須

これは、ジョブの状態や優先度など、ジョブ レベルのデータが最後に変更された時刻です。 新しいタスクの追加やタスクの状態の変更など、タスク レベルの変更は考慮されません。

creation_time
datetime
必須
state
str または JobState
必須

ジョブの現在の状態。 使用可能な値は、'active'、'disableding'、'disabled'、'enabling'、'terminating'、'completed'、'deleting' です。

state_transition_time
datetime
必須
previous_state
str または JobState
必須

ジョブの以前の状態。 ジョブが最初の Active 状態の場合、このプロパティは設定されません。 使用可能な値は、'active'、'disableding'、'disabled'、'enabling'、'terminating'、'completed'、'deleting' です。

previous_state_transition_time
datetime
必須

ジョブが最初の Active 状態の場合、このプロパティは設定されません。

priority
int
必須

ジョブの優先度。 優先度の値の範囲は -1000 から 1000 です。-1000 が最も低い優先度で、1000 が最高の優先度です。 既定値は 0 です。

allow_task_preemption
bool
必須

このジョブ内のタスクを他の優先度の高いジョブに割り込むことができるかどうか。 値が True に設定されている場合、システムに送信された他の優先度の高いジョブが優先され、このジョブからタスクを再キューできます。 ジョブの allowTaskPreemption は、更新ジョブ API を使用して作成した後に更新できます。

max_parallel_tasks
int
必須

ジョブに対して並列に実行できるタスクの最大数。 maxParallelTasks の値は、-1 または指定した場合は 0 より大きくする必要があります。 指定しない場合、既定値は -1 です。つまり、一度に実行できるタスクの数に制限はありません。 ジョブの maxParallelTasks は、更新ジョブ API を使用して作成した後に更新できます。 既定値: -1 。

constraints
JobConstraints
必須

ジョブの実行制約。

job_manager_task
JobManagerTask
必須

ジョブの開始時に起動されるジョブ マネージャー タスクの詳細。

job_preparation_task
JobPreparationTask
必須

ジョブ準備タスク。 ジョブ準備タスクは、ジョブの他のタスクの前に、各コンピューティング ノードで実行される特別なタスクです。

job_release_task
JobReleaseTask
必須

ジョブ解放タスク。 ジョブ解放タスクは、ジョブの他のタスクを実行した各コンピューティング ノードで、ジョブの最後に実行される特別なタスクです。

common_environment_settings
list[EnvironmentSetting]
必須

個々のタスクは、同じ設定名を別の値で指定することで、ここで指定した環境設定をオーバーライドできます。

pool_info
PoolInformation
必須

ジョブに関連付けられているプール設定。

on_all_tasks_complete
str または OnAllTasksComplete
必須

ジョブ内のすべてのタスクが完了状態のときに Batch サービスが実行する必要があるアクション。 既定値は noaction です。 指定できる値は、'noAction'、'terminateJob' です。

on_task_failure
str または OnTaskFailure
必須

ジョブ内のタスクが失敗したときに Batch サービスが実行する必要があるアクション。 task が failureInfo の場合、タスクは失敗したと見なされます。 failureInfo は、再試行回数を使い果たした後にタスクが 0 以外の終了コードで完了した場合、またはリソース ファイルのダウンロード エラーが原因でタスクを開始中にエラーが発生した場合に設定されます。 既定値は noaction です。 使用できる値は、'noAction'、'performExitOptionsJobAction' です。

network_configuration
JobNetworkConfiguration
必須

ジョブのネットワーク構成。

metadata
list[MetadataItem]
必須

Batch サービスは、メタデータに意味を割り当てません。これは、ユーザー コードの使用のみを目的とします。

execution_info
JobExecutionInformation
必須

ジョブの実行情報。

stats
JobStatistics
必須

ジョブの有効期間全体のリソース使用状況統計。 このプロパティは、CloudJob が 'stats' 属性を含む expand 句で取得された場合にのみ設定されます。それ以外の場合は null です。 統計はすぐには使用できない場合があります。 Batch サービスは、統計の定期的なロールアップを実行します。 一般的な遅延は約 30 分です。

メソッド

as_dict

json.dump を使用して JSONify できる dict を返します。

高度な使用法では、必要に応じてコールバックをパラメーターとして使用できます。

キーは、Python で使用される属性名です。 Attr_descはメタデータのディクテーションです。 現在、msrest 型の 'type' と RestAPI でエンコードされたキーを持つ 'key' が含まれています。 値は、このオブジェクトの現在の値です。

返される文字列は、キーのシリアル化に使用されます。 戻り値の型がリストの場合、これは階層的な結果のディクトと見なされます。

このファイルの 3 つの例を参照してください。

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

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' が含まれています。 値は、このオブジェクトの現在の値です。

返される文字列は、キーのシリアル化に使用されます。 戻り値の型がリストの場合、これは階層的な結果のディクトと見なされます。

このファイルの 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
既定値: True

戻り値

dict JSON 互換オブジェクト

の戻り値の型 :

dict

deserialize

RestAPI 構文を使用して str を解析し、モデルを返します。

deserialize(data, content_type=None)

パラメーター

data
str
必須

RestAPI 構造体を使用する str。 既定では JSON。

content_type
str
既定値: None

JSON は既定で、application/xml if XML を設定します。

戻り値

このモデルのインスタンス

例外

DeserializationError if something went wrong

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)

パラメーター

data
dict
必須

RestAPI 構造体を使用したディクテーション

content_type
str
既定値: None

JSON は既定で、application/xml if XML を設定します。

key_extractors
既定値: None

戻り値

このモデルのインスタンス

例外

DeserializationError if something went wrong

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)

パラメーター

keep_readonly
bool
既定値: False

readonly 属性をシリアル化する場合

戻り値

dict JSON 互換オブジェクト

の戻り値の型 :

dict

validate

このモデルを再帰的に検証し、ValidationError の一覧を返します。

validate()

戻り値

検証エラーの一覧

の戻り値の型 :

list