IndexingResult Osztály
Egyetlen dokumentum indexelési műveletének állapota.
A változókat csak a kiszolgáló tölti ki, és a rendszer figyelmen kívül hagyja a kérés küldésekor.
Az Azure-ba való küldéshez minden szükséges paramétert fel kell tölteni.
- Öröklődés
-
azure.search.documents._generated._serialization.ModelIndexingResult
Konstruktor
IndexingResult(**kwargs: Any)
Változók
Name | Description |
---|---|
key
|
Az indexelési kérelemben szereplő dokumentum kulcsa. Kötelező. |
error_message
|
A hibaüzenet azt ismerteti, hogy miért nem sikerült az indexelési művelet a kulcs által azonosított dokumentum esetében; null értékű, ha az indexelés sikeres volt. |
succeeded
|
Érték, amely azt jelzi, hogy az indexelési művelet sikeres volt-e a kulcs által azonosított dokumentum esetében. Kötelező. |
status_code
|
Az indexelési művelet állapotkódja. Lehetséges értékek: 200 sikeres frissítés vagy törlés esetén, 201 sikeres dokumentumlétrehozás, 400 helytelen formátumú bemeneti dokumentum esetén, 404 a dokumentum nem található, 409 verzióütközés esetén, 422, ha az index átmenetileg nem érhető el, vagy 503, ha a szolgáltatás túl elfoglalt. Kötelező. |
Metódusok
as_dict |
A json.dump használatával szerializálható diktálás visszaadása. A speciális használat opcionálisan visszahívást is használhat paraméterként: A kulcs a Pythonban használt attribútumnév. Attr_desc egy metaadat-diktálás. Jelenleg az msrest típust és a RestAPI kódolt kulcsot tartalmazó "típust" tartalmazza. Az érték az objektum aktuális értéke. A visszaadott sztring a kulcs szerializálására szolgál. Ha a visszatérési típus lista, akkor ez hierarchikus eredménydiktátumnak minősül. Tekintse meg a fájl három példáját:
Ha XML-szerializálást szeretne, a kwargs is_xml=True értéket is átadhatja. |
deserialize |
Elemezhet egy str értéket a RestAPI szintaxissal, és visszaad egy modellt. |
enable_additional_properties_sending | |
from_dict |
Egy diktálás elemzése adott kulcselszívó használatával egy modellt ad vissza. Alapértelmezés szerint vegye figyelembe a kulcselszívókat (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor és last_rest_key_case_insensitive_extractor) |
is_xml_model | |
serialize |
Adja vissza a modellből a kiszolgálónak küldendő JSON-t. Ez a as_dict (full_restapi_key_transformer, keep_readonly=False) aliasa. Ha XML-szerializálást szeretne, a kwargs is_xml=True értéket is átadhatja. |
as_dict
A json.dump használatával szerializálható diktálás visszaadása.
A speciális használat opcionálisan visszahívást is használhat paraméterként:
A kulcs a Pythonban használt attribútumnév. Attr_desc egy metaadat-diktálás. Jelenleg az msrest típust és a RestAPI kódolt kulcsot tartalmazó "típust" tartalmazza. Az érték az objektum aktuális értéke.
A visszaadott sztring a kulcs szerializálására szolgál. Ha a visszatérési típus lista, akkor ez hierarchikus eredménydiktátumnak minősül.
Tekintse meg a fájl három példáját:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
Ha XML-szerializálást szeretne, a kwargs is_xml=True értéket is átadhatja.
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]
Paraméterek
Name | Description |
---|---|
key_transformer
|
<xref:function>
Egy kulcsátalakító függvény. |
keep_readonly
|
alapértelmezett érték: True
|
Válaszok
Típus | Description |
---|---|
Diktátum JSON-kompatibilis objektum |
deserialize
Elemezhet egy str értéket a RestAPI szintaxissal, és visszaad egy modellt.
deserialize(data: Any, content_type: str | None = None) -> ModelType
Paraméterek
Name | Description |
---|---|
data
Kötelező
|
RestAPI-struktúrát használó struktúra. JSON alapértelmezés szerint. |
content_type
|
JSON alapértelmezés szerint állítsa be az alkalmazást/xml-t, ha XML. alapértelmezett érték: None
|
Válaszok
Típus | Description |
---|---|
A modell egy példánya |
Kivételek
Típus | Description |
---|---|
DeserializationError if something went wrong
|
enable_additional_properties_sending
enable_additional_properties_sending() -> None
from_dict
Egy diktálás elemzése adott kulcselszívó használatával egy modellt ad vissza.
Alapértelmezés szerint vegye figyelembe a kulcselszívókat (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor és 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
Paraméterek
Name | Description |
---|---|
data
Kötelező
|
Egy restAPI-struktúrát használó diktálás |
content_type
|
JSON alapértelmezés szerint állítsa be az alkalmazást/xml-t, ha XML. alapértelmezett érték: None
|
key_extractors
|
alapértelmezett érték: None
|
Válaszok
Típus | Description |
---|---|
A modell egy példánya |
Kivételek
Típus | Description |
---|---|
DeserializationError if something went wrong
|
is_xml_model
is_xml_model() -> bool
serialize
Adja vissza a modellből a kiszolgálónak küldendő JSON-t.
Ez a as_dict (full_restapi_key_transformer, keep_readonly=False) aliasa.
Ha XML-szerializálást szeretne, a kwargs is_xml=True értéket is átadhatja.
serialize(keep_readonly: bool = False, **kwargs: Any) -> MutableMapping[str, Any]
Paraméterek
Name | Description |
---|---|
keep_readonly
|
Ha szerializálni szeretné az olvasható attribútumokat alapértelmezett érték: False
|
Válaszok
Típus | Description |
---|---|
Diktátum JSON-kompatibilis objektum |
Azure SDK for Python