共用方式為


IndexingResult 類別

單一檔的索引作業狀態。

變數只會由伺服器填入,而且會在傳送要求時予以忽略。

必須填入所有必要的參數,才能傳送至 Azure。

繼承
azure.search.documents._generated._serialization.Model
IndexingResult

建構函式

IndexingResult(**kwargs: Any)

變數

名稱 Description
key
str

索引要求中檔索引鍵。 必要。

error_message
str

錯誤訊息,說明索引編制作業為何因索引鍵所識別的檔而失敗;如果索引成功,則為 null。

succeeded

值,指出索引鍵所識別檔是否成功編制索引作業。 必要。

status_code
int

索引作業的狀態碼。 可能的值包括:200 代表成功更新或刪除、成功建立檔 201、400 表示格式不正確的輸入檔、找不到檔的 404、版本衝突的 409、當索引暫時無法使用時為 422,或當服務太忙碌時為 503。 必要。

方法

as_dict

傳回可使用 json.dump 序列化的聽寫。

進階用法可以選擇性地使用回呼作為參數:

索引鍵是 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

傳回會從此模型傳送至伺服器的 JSON。

這是as_dict (full_restapi_key_transformer的別名 ,keep_readonly=False)

如果您想要 XML 序列化,您可以傳遞 kwargs is_xml=True。

as_dict

傳回可使用 json.dump 序列化的聽寫。

進階用法可以選擇性地使用回呼作為參數:

索引鍵是 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: bool = True, key_transformer: ~typing.Callable[[str, ~typing.Dict[str, ~typing.Any], ~typing.Any], ~typing.Any] = <function attribute_transformer>, **kwargs: ~typing.Any) -> MutableMapping[str, Any]

參數

名稱 Description
key_transformer
<xref:function>

按鍵轉換程式函式。

keep_readonly
預設值: True

傳回

類型 Description

聽寫 JSON 相容物件

deserialize

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

deserialize(data: Any, content_type: str | None = None) -> ModelType

參數

名稱 Description
data
必要
str

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

content_type
str

根據預設,如果 XML,請設定 application/xml。

預設值: None

傳回

類型 Description

此模型的實例

例外狀況

類型 Description
DeserializationError if something went wrong

enable_additional_properties_sending

enable_additional_properties_sending() -> None

from_dict

使用指定的索引鍵擷取器剖析聽寫會傳回模型。

根據預設,請考慮金鑰擷取器 (rest_key_case_insensitive_extractor、attribute_key_case_insensitive_extractor和last_rest_key_case_insensitive_extractor)

from_dict(data: Any, key_extractors: Callable[[str, Dict[str, Any], Any], Any] | None = None, content_type: str | None = None) -> ModelType

參數

名稱 Description
data
必要

使用 RestAPI 結構的聽寫

content_type
str

根據預設,如果 XML,請設定 application/xml。

預設值: None
key_extractors
預設值: None

傳回

類型 Description

此模型的實例

例外狀況

類型 Description
DeserializationError if something went wrong

is_xml_model

is_xml_model() -> bool

serialize

傳回會從此模型傳送至伺服器的 JSON。

這是as_dict (full_restapi_key_transformer的別名 ,keep_readonly=False)

如果您想要 XML 序列化,您可以傳遞 kwargs is_xml=True。

serialize(keep_readonly: bool = False, **kwargs: Any) -> MutableMapping[str, Any]

參數

名稱 Description
keep_readonly

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

預設值: False

傳回

類型 Description

聽寫 JSON 相容物件