ExitConditions 類別

指定 Batch 服務在工作完成時應該如何回應。

繼承

Model

ExitConditions

建構函式

ExitConditions(*, exit_codes=None, exit_code_ranges=None, pre_processing_error=None, file_upload_error=None, default=None, **kwargs)

參數

exit_codes

list[ExitCodeMapping]

必要

exit_code_ranges

list[ExitCodeRangeMapping]

必要

pre_processing_error

ExitOptions

必要

如果工作因為錯誤而無法啟動，Batch 服務應該如何回應。

file_upload_error

ExitOptions

必要

如果發生檔案上傳錯誤，Batch 服務應該如何回應。 如果工作結束且結束代碼是透過 exitCodes 或 exitCodeRanges 所指定的結束代碼，然後遇到檔案上傳錯誤，則結束碼所指定的動作優先。

default

ExitOptions

必要

如果工作失敗，且任何其他屬性未涵蓋結束條件，Batch 服務應該如何回應。 如果 Task 結束且 exitCodes 或 exitCodeRanges 集合中未列出的非零結束代碼，如果 preProcessingError 屬性不存在，則會使用前置處理錯誤，如果 fileUploadError 屬性不存在，則會使用檔案上傳錯誤。 如果您想要結束代碼 0 上的非預設行為，您必須使用 exitCodes 或 exitCodeRanges 集合明確列出它。

方法

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