IndexingResult Clase
Estado de una operación de indexación para un único documento.
Las variables solo se rellenan mediante el servidor y se omitirán al enviar una solicitud.
Todos los parámetros necesarios deben rellenarse para enviarlos a Azure.
- Herencia
-
azure.search.documents._generated._serialization.ModelIndexingResult
Constructor
IndexingResult(**kwargs: Any)Variables
| Nombre | Description |
|---|---|
|
key
|
Clave de un documento que estaba en la solicitud de indexación. Necesario. |
|
error_message
|
Mensaje de error que explica por qué se produjo un error en la operación de indexación para el documento identificado por la clave; null si la indexación se realizó correctamente. |
|
succeeded
|
Valor que indica si la operación de indexación se realizó correctamente para el documento identificado por la clave. Necesario. |
|
status_code
|
Código de estado de la operación de indexación. Entre los valores posibles se incluyen: 200 para una actualización o eliminación correcta, 201 para la creación correcta de documentos, 400 para un documento de entrada con formato incorrecto, 404 para el documento no encontrado, 409 para un conflicto de versión, 422 cuando el índice no está disponible temporalmente o 503 para cuando el servicio está demasiado ocupado. Necesario. |
Métodos
| as_dict |
Devuelve un dict que se puede serializar mediante json.dump. El uso avanzado podría usar opcionalmente una devolución de llamada como parámetro: Key es el nombre de atributo que se usa en Python. Attr_desc es un dict de metadatos. Actualmente contiene 'type' con el tipo msrest y 'key' con la clave codificada restAPI. Value es el valor actual de este objeto. La cadena devuelta se usará para serializar la clave. Si el tipo de valor devuelto es una lista, se considera dict de resultados jerárquicos. Consulte los tres ejemplos de este archivo:
Si desea serialización XML, puede pasar los kwargs is_xml=True. |
| deserialize |
Analice una cadena mediante la sintaxis restAPI y devuelva un modelo. |
| enable_additional_properties_sending | |
| from_dict |
Analizar un dict mediante un extractor de claves dado devuelve un modelo. De forma predeterminada, considere la posibilidad de extractores de claves (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor y last_rest_key_case_insensitive_extractor) |
| is_xml_model | |
| serialize |
Devuelve el JSON que se enviaría al servidor desde este modelo. Se trata de un alias para as_dict(full_restapi_key_transformer, keep_readonly=False). Si desea serialización XML, puede pasar los kwargs is_xml=True. |
as_dict
Devuelve un dict que se puede serializar mediante json.dump.
El uso avanzado podría usar opcionalmente una devolución de llamada como parámetro:
Key es el nombre de atributo que se usa en Python. Attr_desc es un dict de metadatos. Actualmente contiene 'type' con el tipo msrest y 'key' con la clave codificada restAPI. Value es el valor actual de este objeto.
La cadena devuelta se usará para serializar la clave. Si el tipo de valor devuelto es una lista, se considera dict de resultados jerárquicos.
Consulte los tres ejemplos de este archivo:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
Si desea serialización XML, puede pasar los 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]Parámetros
| Nombre | Description |
|---|---|
|
key_transformer
|
<xref:function>
Una función de transformador de teclas. |
|
keep_readonly
|
valor predeterminado: True
|
Devoluciones
| Tipo | Description |
|---|---|
|
Un objeto compatible con JSON dict |
deserialize
Analice una cadena mediante la sintaxis restAPI y devuelva un modelo.
deserialize(data: Any, content_type: str | None = None) -> ModelTypeParámetros
| Nombre | Description |
|---|---|
|
data
Requerido
|
Una cadena de datos mediante la estructura restAPI. JSON de forma predeterminada. |
|
content_type
|
JSON de forma predeterminada, establezca application/xml si XML. valor predeterminado: None
|
Devoluciones
| Tipo | Description |
|---|---|
|
Una instancia de este modelo |
Excepciones
| Tipo | Description |
|---|---|
|
DeserializationError if something went wrong
|
enable_additional_properties_sending
enable_additional_properties_sending() -> Nonefrom_dict
Analizar un dict mediante un extractor de claves dado devuelve un modelo.
De forma predeterminada, considere la posibilidad de extractores de claves (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor y 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) -> ModelTypeParámetros
| Nombre | Description |
|---|---|
|
data
Requerido
|
Un dict mediante la estructura restAPI |
|
content_type
|
JSON de forma predeterminada, establezca application/xml si XML. valor predeterminado: None
|
|
key_extractors
|
valor predeterminado: None
|
Devoluciones
| Tipo | Description |
|---|---|
|
Una instancia de este modelo |
Excepciones
| Tipo | Description |
|---|---|
|
DeserializationError if something went wrong
|
is_xml_model
is_xml_model() -> boolserialize
Devuelve el JSON que se enviaría al servidor desde este modelo.
Se trata de un alias para as_dict(full_restapi_key_transformer, keep_readonly=False).
Si desea serialización XML, puede pasar los kwargs is_xml=True.
serialize(keep_readonly: bool = False, **kwargs: Any) -> MutableMapping[str, Any]Parámetros
| Nombre | Description |
|---|---|
|
keep_readonly
|
Si desea serializar los atributos de solo lectura valor predeterminado: False
|
Devoluciones
| Tipo | Description |
|---|---|
|
Un objeto compatible con JSON dict |
Azure SDK for Python