IndexerExecutionResult クラス
個々のインデクサー実行の結果を表します。
変数はサーバーによってのみ設定され、要求の送信時には無視されます。
Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
- 継承
-
azure.search.documents.indexes._generated._serialization.ModelIndexerExecutionResult
コンストラクター
IndexerExecutionResult(**kwargs: Any)変数
| 名前 | 説明 |
|---|---|
|
status
|
str または
<xref:search_service_client.models.IndexerExecutionStatus>
このインデクサー実行の結果。 必須。 既知の値は、"transientFailure"、"success"、"inProgress"、および "reset" です。 |
|
error_message
|
最上位レベルのエラー (存在する場合) を示すエラー メッセージ。 |
|
start_time
|
このインデクサー実行の開始時刻。 |
|
end_time
|
このインデクサー実行の終了時刻 (実行が既に完了している場合)。 |
|
errors
|
list[<xref:search_service_client.models.SearchIndexerError>]
項目レベルのインデックス作成エラー。 必須。 |
|
warnings
|
list[<xref:search_service_client.models.SearchIndexerWarning>]
項目レベルのインデックス作成の警告。 必須。 |
|
item_count
|
このインデクサーの実行中に処理された項目の数。 これには、正常に処理された項目と、インデックス作成が試行されたが失敗した項目の両方が含まれます。 必須。 |
|
failed_item_count
|
このインデクサーの実行中にインデックスを作成できなかった項目の数。 必須。 |
|
initial_tracking_state
|
インデクサーの実行が開始された追跡状態を変更します。 |
|
final_tracking_state
|
インデクサーの実行が完了した追跡状態を変更します。 |
メソッド
| as_dict |
json.dump を使用してシリアル化できる dict を返します。 高度な使用法では、必要に応じてコールバックをパラメーターとして使用できます。 キーは、Python で使用される属性名です。 Attr_descはメタデータのディクテーションです。 現在、msrest 型の 'type' と RestAPI でエンコードされたキーを持つ 'key' が含まれています。 値は、このオブジェクトの現在の値です。 返される文字列は、キーのシリアル化に使用されます。 戻り値の型がリストの場合、これは階層的な結果 dict と見なされます。 このファイルの 3 つの例を参照してください。
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 を使用してシリアル化できる dict を返します。
高度な使用法では、必要に応じてコールバックをパラメーターとして使用できます。
キーは、Python で使用される属性名です。 Attr_descはメタデータのディクテーションです。 現在、msrest 型の 'type' と RestAPI でエンコードされたキーを持つ 'key' が含まれています。 値は、このオブジェクトの現在の値です。
返される文字列は、キーのシリアル化に使用されます。 戻り値の型がリストの場合、これは階層的な結果 dict と見なされます。
このファイルの 3 つの例を参照してください。
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]パラメーター
| 名前 | 説明 |
|---|---|
|
key_transformer
|
<xref:function>
キー トランスフォーマー関数。 |
|
keep_readonly
|
既定値: True
|
戻り値
| 型 | 説明 |
|---|---|
|
dict JSON 互換オブジェクト |
deserialize
RestAPI 構文を使用して str を解析し、モデルを返します。
deserialize(data: Any, content_type: str | None = None) -> ModelTypeパラメーター
| 名前 | 説明 |
|---|---|
|
data
必須
|
RestAPI 構造体を使用する str。 既定では JSON。 |
|
content_type
|
既定では JSON、XML の場合は application/xml を設定します。 既定値: None
|
戻り値
| 型 | 説明 |
|---|---|
|
このモデルのインスタンス |
例外
| 型 | 説明 |
|---|---|
|
DeserializationError if something went wrong
|
enable_additional_properties_sending
enable_additional_properties_sending() -> Nonefrom_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パラメーター
| 名前 | 説明 |
|---|---|
|
data
必須
|
RestAPI 構造体を使用したディクテーション |
|
content_type
|
既定では JSON、XML の場合は application/xml を設定します。 既定値: None
|
|
key_extractors
|
既定値: None
|
戻り値
| 型 | 説明 |
|---|---|
|
このモデルのインスタンス |
例外
| 型 | 説明 |
|---|---|
|
DeserializationError if something went wrong
|
is_xml_model
is_xml_model() -> boolserialize
このモデルからサーバーに送信される 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]パラメーター
| 名前 | 説明 |
|---|---|
|
keep_readonly
|
読み取り専用属性をシリアル化する場合 既定値: False
|
戻り値
| 型 | 説明 |
|---|---|
|
dict JSON 互換オブジェクト |
Azure SDK for Python