IndexAction Klasse

Stellt eine Indexaktion dar, die für ein Dokument ausgeführt wird.

Vererbung

azure.search.documents._generated._serialization.Model

IndexAction

Konstruktor

IndexAction(*, additional_properties: Dict[str, Any] | None = None, action_type: str | _models.IndexActionType | None = None, **kwargs: Any)

Nur Schlüsselwortparameter

Name	Beschreibung
additional_properties	dict[str, any] Nicht übereinstimmende Eigenschaften aus der Nachricht werden für diese Auflistung deserialisiert.
action_type	str oder <xref:azure.search.documents.models.IndexActionType> Der Vorgang, der für ein Dokument in einem Indizierungsbatch ausgeführt werden soll. Bekannte Werte sind: "upload", "merge", "mergeOrUpload" und "delete".

Variablen

Name	Beschreibung
additional_properties	dict[str, any] Nicht übereinstimmende Eigenschaften aus der Nachricht werden für diese Auflistung deserialisiert.
action_type	str oder <xref:azure.search.documents.models.IndexActionType> Der Vorgang, der für ein Dokument in einem Indizierungsbatch ausgeführt werden soll. Bekannte Werte sind: "upload", "merge", "mergeOrUpload" und "delete".

Methoden

as_dict	Gibt ein Diktat zurück, das mit json.dump serialisiert werden kann. Bei erweiterter Verwendung kann optional ein Rückruf als Parameter verwendet werden: Key ist der Attributname, der in Python verwendet wird. Attr_desc ist ein Diktat von Metadaten. Enthält derzeit "type" mit dem Msrest-Typ und "key" mit dem RestAPI-codierten Schlüssel. Value ist der aktuelle Wert in diesem Objekt. Die zurückgegebene Zeichenfolge wird verwendet, um den Schlüssel zu serialisieren. Wenn der Rückgabetyp eine Liste ist, wird dies als hierarchische Ergebnisdikt betrachtet. Sehen Sie sich die drei Beispiele in dieser Datei an: attribute_transformer full_restapi_key_transformer last_restapi_key_transformer Wenn Sie eine XML-Serialisierung wünschen, können Sie die kwargs is_xml=True übergeben.
deserialize	Analysieren Sie eine str mithilfe der RestAPI-Syntax, und geben Sie ein Modell zurück.
enable_additional_properties_sending
from_dict	Analysieren eines Diktats mit dem angegebenen Schlüsselextraktor gibt ein Modell zurück. Berücksichtigen Sie standardmäßig Schlüsselextraktoren (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor und last_rest_key_case_insensitive_extractor)
is_xml_model
serialize	Gibt den JSON-Code zurück, der von diesem Modell an den Server gesendet wird. Dies ist ein Alias für as_dict(full_restapi_key_transformer, keep_readonly=False). Wenn Sie eine XML-Serialisierung wünschen, können Sie die kwargs is_xml=True übergeben.

as_dict

Gibt ein Diktat zurück, das mit json.dump serialisiert werden kann.

Bei erweiterter Verwendung kann optional ein Rückruf als Parameter verwendet werden:

Key ist der Attributname, der in Python verwendet wird. Attr_desc ist ein Diktat von Metadaten. Enthält derzeit "type" mit dem Msrest-Typ und "key" mit dem RestAPI-codierten Schlüssel. Value ist der aktuelle Wert in diesem Objekt.

Die zurückgegebene Zeichenfolge wird verwendet, um den Schlüssel zu serialisieren. Wenn der Rückgabetyp eine Liste ist, wird dies als hierarchische Ergebnisdikt betrachtet.

Sehen Sie sich die drei Beispiele in dieser Datei an:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

Wenn Sie eine XML-Serialisierung wünschen, können Sie die kwargs is_xml=True übergeben.

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]

Parameter

Name	Beschreibung
key_transformer	<xref:function> Eine Schlüsseltransformatorfunktion.
keep_readonly	Standardwert: True

Gibt zurück

Typ	Beschreibung
dict	Ein JSON-kompatibles Diktatobjekt

deserialize

Analysieren Sie eine str mithilfe der RestAPI-Syntax, und geben Sie ein Modell zurück.

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

Parameter

Name	Beschreibung
data Erforderlich	str Eine str-Struktur, die die RestAPI-Struktur verwendet. Standardmäßig JSON.
content_type	str Json standardmäßig, legen Sie application/xml fest, wenn XML. Standardwert: None

Gibt zurück

Typ	Beschreibung
	Eine instance dieses Modells

Ausnahmen

Typ	Beschreibung
DeserializationError if something went wrong

enable_additional_properties_sending

enable_additional_properties_sending() -> None

from_dict

Analysieren eines Diktats mit dem angegebenen Schlüsselextraktor gibt ein Modell zurück.

Berücksichtigen Sie standardmäßig Schlüsselextraktoren (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor und 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

Parameter

Name	Beschreibung
data Erforderlich	dict Ein Diktat mithilfe der RestAPI-Struktur
content_type	str Json standardmäßig, legen Sie application/xml fest, wenn XML. Standardwert: None
key_extractors	Standardwert: None

Gibt zurück

Typ	Beschreibung
	Eine instance dieses Modells

Ausnahmen

Typ	Beschreibung
DeserializationError if something went wrong

is_xml_model

is_xml_model() -> bool

serialize

Gibt den JSON-Code zurück, der von diesem Modell an den Server gesendet wird.

Dies ist ein Alias für as_dict(full_restapi_key_transformer, keep_readonly=False).

Wenn Sie eine XML-Serialisierung wünschen, können Sie die kwargs is_xml=True übergeben.

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

Parameter

Name	Beschreibung
keep_readonly	bool Wenn Sie die schreibgeschützten Attribute serialisieren möchten Standardwert: False

Gibt zurück

Typ	Beschreibung
dict	Ein JSON-kompatibles Diktatobjekt