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
必要。 識別碼可以包含英數位元的任何組合,包括連字號和底線,而且不能包含超過 64 個字元。 識別碼會保留大小寫且不區分大小寫 (,也就是說,您可能在帳戶中沒有兩個識別碼,而該識別碼只依大小寫) 而有所不同。
- max_parallel_tasks
- int
工作可以平行執行的工作數目上限。 maxParallelTasks 的值必須為 -1,如果指定則大於 0。 如果未指定,預設值為 -1,這表示一次可以執行的工作數目沒有限制。 您可以使用更新作業 API 建立作業之後,更新作業的 maxParallelTasks。 預設值:-1 。
- allow_task_preemption
- bool
此作業中的工作是否可以由其他高優先順序工作先占。 如果此值設定為 True,則提交至系統的其他高優先順序工作會優先,而且能夠從此作業重新排入工作佇列。 您可以使用更新作業 API 建立作業之後,更新作業的 allowTaskPreemption。
- job_manager_task
- JobManagerTask
啟動作業時要啟動的作業管理員工作詳細資料。 如果作業未指定作業管理員工作,使用者必須明確地將工作新增至作業。 如果作業確實指定作業管理員工作,Batch 服務會在建立作業時建立作業管理員工作,並嘗試排程作業管理員工作,再排程作業中的其他工作。 作業管理員工作的一般用途是控制及/或監視作業執行,例如決定要執行的其他工作、判斷工作完成時間等等。不過, (作業管理員工作不限於這些活動 - 它是系統中的完整工作,而且會執行 Job.) 所需的任何動作。例如,作業管理員工作可能會下載指定為參數的檔案、分析該檔案的內容,並根據這些內容提交其他工作。
- job_preparation_task
- JobPreparationTask
作業準備工作。 如果作業具有作業準備工作,Batch 服務會在節點上執行作業準備工作,再在該計算節點上啟動該作業的任何工作。
- job_release_task
- JobReleaseTask
作業發行工作。 若未同時指定作業的作業準備工作,就無法指定作業發行工作。 Batch 服務會在執行作業準備工作的節點上執行作業發行工作。 作業發行工作的主要用途是復原作業準備工作所做的計算節點變更。 範例活動包括刪除本機檔案,或關閉在作業準備過程中啟動的服務。
- on_all_tasks_complete
- str 或 OnAllTasksComplete
當作業中的所有工作都處於已完成狀態時,Batch 服務應該採取的動作。 請注意,如果作業不包含任何工作,則所有工作都會被視為完成。 因此,此選項最常與作業管理員工作搭配使用;如果您想要在沒有作業管理員的情況下使用自動作業終止,您應該一開始將 onAllTasksComplete 設定為 noaction,並更新 Job 屬性,以在完成新增工作之後,將 onAllTasksComplete 設定為 terminatejob。 預設值為 noaction。 可能的值包括:'noAction'、'terminateJob'
- on_task_failure
- str 或 OnTaskFailure
當作業中的任何工作失敗時,Batch 服務應該採取的動作。 如果 failureInfo 失敗,工作就會被視為失敗。 如果工作在耗盡重試計數之後完成非零結束代碼,或啟動工作時發生錯誤,例如資源檔下載錯誤,則會設定 failureInfo。 預設值為 noaction。 可能的值包括:'noAction'、'performExitOptionsJobAction'
方法
as_dict |
使用 json.dump 傳回可以是 JSONify 的聽寫。 進階用法可以選擇性地使用回呼作為參數: 索引鍵是 Python 中使用的屬性名稱。 Attr_desc是中繼資料的聽寫。 目前包含具有 msrest 類型的 'type',以及具有 RestAPI 編碼金鑰的 'key'。 Value 是這個 物件中的目前值。 傳回的字串將用來序列化索引鍵。 如果傳回類型是清單,則會將此視為階層式結果聽寫。 請參閱此檔案中的三個範例:
如果您想要 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 的聽寫。
進階用法可以選擇性地使用回呼作為參數:
索引鍵是 Python 中使用的屬性名稱。 Attr_desc是中繼資料的聽寫。 目前包含具有 msrest 類型的 'type',以及具有 RestAPI 編碼金鑰的 'key'。 Value 是這個 物件中的目前值。
傳回的字串將用來序列化索引鍵。 如果傳回類型是清單,則會將此視為階層式結果聽寫。
請參閱此檔案中的三個範例:
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
傳回
聽寫 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)
參數
傳回
聽寫 JSON 相容物件