IndexAction Klasa

Reprezentuje akcję indeksu działającą na dokumencie.

Dziedziczenie

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)

Parametry Tylko słowo kluczowe

Nazwa	Opis
additional_properties	dict[str, any] Niedopasowane właściwości z komunikatu są deserializowane do tej kolekcji.
action_type	str lub <xref:azure.search.documents.models.IndexActionType> Operacja wykonywana na dokumencie w partii indeksowania. Znane wartości to: "upload", "merge", "mergeOrUpload" i "delete".

Zmienne

Nazwa	Opis
additional_properties	dict[str, any] Niedopasowane właściwości z komunikatu są deserializowane do tej kolekcji.
action_type	str lub <xref:azure.search.documents.models.IndexActionType> Operacja wykonywana na dokumencie w partii indeksowania. Znane wartości to: "upload", "merge", "mergeOrUpload" i "delete".

Metody

as_dict	Zwróć dykt, który można serializować przy użyciu pliku json.dump. Użycie zaawansowane może opcjonalnie używać wywołania zwrotnego jako parametru: Klucz to nazwa atrybutu używana w języku Python. Attr_desc to dykt metadanych. Obecnie zawiera ciąg "type" z typem msrest i kluczem zakodowanym za pomocą interfejsu RESTAPI. Wartość jest bieżącą wartością w tym obiekcie. Zwrócony ciąg będzie używany do serializacji klucza. Jeśli zwracany typ jest listą, jest to uznawane za hierarchiczny dykt wyniku. Zobacz trzy przykłady w tym pliku: attribute_transformer full_restapi_key_transformer last_restapi_key_transformer Jeśli chcesz serializacji XML, możesz przekazać kwargs is_xml=True.
deserialize	Analizowanie ciągu przy użyciu składni restAPI i zwracanie modelu.
enable_additional_properties_sending
from_dict	Przeanalizuj dykt przy użyciu danego modułu wyodrębniającego klucz, który zwraca model. Domyślnie należy rozważyć wyodrębnianie kluczy (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor i last_rest_key_case_insensitive_extractor)
is_xml_model
serialize	Zwróć kod JSON, który zostanie wysłany do serwera z tego modelu. Jest to alias as_dict (full_restapi_key_transformer, keep_readonly=False). Jeśli chcesz serializacji XML, możesz przekazać kwargs is_xml=True.

as_dict

Zwróć dykt, który można serializować przy użyciu pliku json.dump.

Użycie zaawansowane może opcjonalnie używać wywołania zwrotnego jako parametru:

Klucz to nazwa atrybutu używana w języku Python. Attr_desc to dykt metadanych. Obecnie zawiera ciąg "type" z typem msrest i kluczem zakodowanym za pomocą interfejsu RESTAPI. Wartość jest bieżącą wartością w tym obiekcie.

Zwrócony ciąg będzie używany do serializacji klucza. Jeśli zwracany typ jest listą, jest to uznawane za hierarchiczny dykt wyniku.

Zobacz trzy przykłady w tym pliku:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

Jeśli chcesz serializacji XML, możesz przekazać 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]

Parametry

Nazwa	Opis
key_transformer	<xref:function> Funkcja transformatora klucza.
keep_readonly	Domyślna wartość: True

Zwraca

Typ	Opis
dict	Obiekt zgodny z dyktacją JSON

deserialize

Analizowanie ciągu przy użyciu składni restAPI i zwracanie modelu.

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

Parametry

Nazwa	Opis
data Wymagane	str Str używający struktury RestAPI. Domyślnie dane JSON.
content_type	str Domyślnie w formacie JSON ustaw wartość application/xml, jeśli plik XML. Domyślna wartość: None

Zwraca

Typ	Opis
	Wystąpienie tego modelu

Wyjątki

Typ	Opis
DeserializationError if something went wrong

enable_additional_properties_sending

enable_additional_properties_sending() -> None

from_dict

Przeanalizuj dykt przy użyciu danego modułu wyodrębniającego klucz, który zwraca model.

Domyślnie należy rozważyć wyodrębnianie kluczy (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor i 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

Parametry

Nazwa	Opis
data Wymagane	dict Dykt używający struktury RestAPI
content_type	str Domyślnie w formacie JSON ustaw wartość application/xml, jeśli plik XML. Domyślna wartość: None
key_extractors	Domyślna wartość: None

Zwraca

Typ	Opis
	Wystąpienie tego modelu

Wyjątki

Typ	Opis
DeserializationError if something went wrong

is_xml_model

is_xml_model() -> bool

serialize

Zwróć kod JSON, który zostanie wysłany do serwera z tego modelu.

Jest to alias as_dict (full_restapi_key_transformer, keep_readonly=False).

Jeśli chcesz serializacji XML, możesz przekazać kwargs is_xml=True.

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

Parametry

Nazwa	Opis
keep_readonly	bool Jeśli chcesz serializować atrybuty tylko do odczytu Domyślna wartość: False

Zwraca

Typ	Opis
dict	Obiekt zgodny z dyktacją JSON