共用方式為

JobPatchParameter 類別

  • 參考

要對作業進行的一組變更。

繼承
Model
JobPatchParameter

建構函式

JobPatchParameter(*, priority: int = None, max_parallel_tasks: int = None, allow_task_preemption: bool = None, on_all_tasks_complete=None, constraints=None, pool_info=None, metadata=None, **kwargs)

參數

priority
int
必要

作業的優先順序。 優先順序值的範圍從 -1000 到 1000，-1000 表示最低優先順序，1000 表示最高優先順序。 如果省略，作業的優先順序會保持不變。

max_parallel_tasks
int
必要

工作可以平行執行的工作數目上限。 maxParallelTasks 的值必須為 -1，如果指定則大於 0。 如果未指定，預設值為 -1，這表示一次可以執行的工作數目沒有限制。 您可以使用更新作業 API 建立作業之後，更新作業的 maxParallelTasks。

allow_task_preemption
bool
必要

此作業中的工作是否可以由其他高優先順序工作先占。 如果此值設定為 True，則提交至系統的其他高優先順序工作會優先，而且能夠從此作業重新排入工作佇列。 您可以使用更新作業 API 建立作業之後，更新作業的 allowTaskPreemption。

on_all_tasks_complete
str 或 OnAllTasksComplete
必要

當作業中的所有工作都處於已完成狀態時，Batch 服務應該採取的動作。 如果省略，則完成行為會保持不變。 您可能不會將值從 terminatejob 變更為 noaction，也就是說，一旦參與自動作業終止，就無法再次關閉它。 如果您嘗試這樣做，要求會失敗，並出現「無效屬性值」錯誤回應;如果您要直接呼叫 REST API，HTTP 狀態碼為 400 (「不正確的要求」) 。 可能的值包括：'noAction'、'terminateJob'

constraints
JobConstraints
必要

作業的執行條件約束。 如果省略，現有的執行條件約束會保持不變。

pool_info
PoolInformation
必要

Batch 服務執行作業工作的集區。 只有在作業停用時，您才能變更作業的集區。 如果您包含 poolInfo 元素且作業未停用，修補作業呼叫將會失敗。 如果您在 poolInfo 中指定 autoPoolSpecification，則只能更新 autoPoolSpecification 的 keepAlive 屬性，然後只有在 autoPoolSpecification 有 poolLifetimeOption 的 Job (其他作業屬性可以更新為一般) 。 如果省略，作業會繼續在其目前的集區上執行。

metadata
list[MetadataItem]
必要

如果省略，現有的作業中繼資料會保持不變。

方法

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。
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
預設值: True

傳回

聽寫 JSON 相容物件

傳回類型

dict

deserialize

使用 RestAPI 語法剖析 str 並傳回模型。

deserialize(data, content_type=None)

參數

data
str
必要

使用 RestAPI 結構的 str。 根據預設，JSON。

content_type
str
預設值: None

根據預設，如果 XML，請設定 application/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

根據預設，如果 XML，請設定 application/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

如果您想要序列化唯讀屬性

傳回

聽寫 JSON 相容物件

傳回類型

dict

validate

以遞迴方式驗證此模型，並傳回 ValidationError 的清單。

validate()

傳回

驗證錯誤清單

傳回類型

list