JobGetOptions Clase
Parámetros adicionales para la operación get.
- Herencia
-
JobGetOptions
Constructor
JobGetOptions(*, select: str = None, expand: str = None, timeout: int = 30, client_request_id: str = None, return_client_request_id: bool = False, ocp_date=None, if_match: str = None, if_none_match: str = None, if_modified_since=None, if_unmodified_since=None, **kwargs)
Parámetros
- timeout
- int
Tiempo máximo que el servidor puede dedicar a procesar la solicitud, en segundos. El valor predeterminado es 30 segundos. Valor predeterminado: 30 .
- client_request_id
- str
La identidad de solicitud generada por el autor de la llamada, en forma de GUID sin decoración como llaves, por ejemplo, 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
- return_client_request_id
- bool
Si el servidor debe devolver el client-request-id en la respuesta. Valor predeterminado: False .
- ocp_date
- datetime
Hora en que se emitió la solicitud. Las bibliotecas cliente suelen establecer esto en la hora del reloj del sistema actual; establézcalo explícitamente si llama directamente a la API REST.
- if_match
- str
Valor ETag asociado a la versión del recurso conocido para el cliente. La operación solo se realizará si la ETag actual del recurso en el servicio coincide exactamente con el valor especificado por el cliente.
- if_none_match
- str
Valor ETag asociado a la versión del recurso conocido para el cliente. La operación solo se realizará si la ETag actual del recurso en el servicio no coincide con el valor especificado por el cliente.
- if_modified_since
- datetime
Marca de tiempo que indica la hora de la última modificación del recurso conocido para el cliente. La operación solo se realizará si el recurso del servicio se ha modificado desde la hora especificada.
- if_unmodified_since
- datetime
Marca de tiempo que indica la hora de la última modificación del recurso conocido para el cliente. La operación solo se realizará si el recurso del servicio no se ha modificado desde el momento especificado.
Métodos
as_dict |
Devuelve un dict que puede ser JSONify 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:
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 a Azure 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. |
validate |
Valide este modelo de forma recursiva y devuelva una lista de ValidationError. |
as_dict
Devuelve un dict que puede ser JSONify 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=True, key_transformer=<function attribute_transformer>, **kwargs)
Parámetros
- key_transformer
- <xref:function>
Función de transformador de teclas.
- keep_readonly
Devoluciones
Un objeto compatible con JSON dict
Tipo de valor devuelto
deserialize
Analice una cadena mediante la sintaxis restAPI y devuelva un modelo.
deserialize(data, content_type=None)
Parámetros
- data
- 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.
Devoluciones
Instancia de este modelo
Excepciones
enable_additional_properties_sending
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)
from_dict(data, key_extractors=None, content_type=None)
Parámetros
- content_type
- str
JSON de forma predeterminada, establezca application/xml si XML.
- key_extractors
Devoluciones
Instancia de este modelo
Excepciones
is_xml_model
is_xml_model()
serialize
Devuelve el JSON que se enviaría a Azure 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=False, **kwargs)
Parámetros
Devoluciones
Un objeto compatible con JSON dict
Tipo de valor devuelto
validate
Valide este modelo de forma recursiva y devuelva una lista de ValidationError.
validate()
Devoluciones
Una lista de errores de validación
Tipo de valor devuelto
Azure SDK for Python