IndexAction Clase

  • Referencia

Representa una acción de índice que funciona en un documento.

Herencia
azure.search.documents._generated._serialization.Model
IndexAction

Constructor

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

Parámetros de palabra clave únicamente

Nombre Description
additional_properties
dict[str, any]

Las propiedades no coincidentes del mensaje se deserializan en esta colección.
action_type
str o <xref:azure.search.documents.models.IndexActionType>

Operación que se va a realizar en un documento en un lote de indexación. Los valores conocidos son: "upload", "merge", "mergeOrUpload" y "delete".

Variables

Nombre Description
additional_properties
dict[str, any]

Las propiedades no coincidentes del mensaje se deserializan en esta colección.
action_type
str o <xref:azure.search.documents.models.IndexActionType>

Operación que se va a realizar en un documento en un lote de indexación. Los valores conocidos son: "upload", "merge", "mergeOrUpload" y "delete".

Métodos

as_dict

Devuelve un dict que se puede serializar mediante json.dump.

El uso avanzado puede 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 una diferencia de resultado jerárquica.

Vea 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.
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 puede 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 una diferencia de resultado jerárquica.

Vea 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>

Función de transformador de teclas.
keep_readonly
Valor predeterminado: True

Devoluciones

Tipo Description
dict

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) -> ModelType

Parámetros

Nombre Description
data
Requerido
str

Una cadena de datos mediante la estructura restAPI. JSON de forma predeterminada.
content_type
str

JSON de forma predeterminada, establezca application/xml si XML.

Valor predeterminado: None

Devoluciones

Tipo Description

Instancia de este modelo

Excepciones

Tipo Description
DeserializationError if something went wrong

enable_additional_properties_sending 

enable_additional_properties_sending() -> None

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)

from_dict(data: Any, key_extractors: Callable[[str, Dict[str, Any], Any], Any] | None = None, content_type: str | None = None) -> ModelType

Parámetros

Nombre Description
data
Requerido
dict

Un dict mediante la estructura restAPI
content_type
str

JSON de forma predeterminada, establezca application/xml si XML.

Valor predeterminado: None
key_extractors
Valor predeterminado: None

Devoluciones

Tipo Description

Instancia de este modelo

Excepciones

Tipo Description
DeserializationError if something went wrong

is_xml_model 

is_xml_model() -> bool

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.

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

Parámetros

Nombre Description
keep_readonly
bool

Si desea serializar los atributos de solo lectura

Valor predeterminado: False

Devoluciones

Tipo Description
dict

Un objeto compatible con JSON dict