JobListOptions Clase

Parámetros adicionales para la operación de lista.

Herencia

Model

JobListOptions

Constructor

JobListOptions(*, filter: str = None, select: str = None, expand: str = None, max_results: int = 1000, timeout: int = 30, client_request_id: str = None, return_client_request_id: bool = False, ocp_date=None, **kwargs)

Parámetros

filter

str

Requerido

Una cláusula $filter OData. Para obtener más información sobre cómo construir este filtro, vea https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-jobs.

select

str

Requerido

Una cláusula $select OData.

expand

str

Requerido

Una cláusula $expand OData.

max_results

int

Requerido

Número máximo de elementos que se van a devolver en la respuesta. Se puede devolver un máximo de 1000 trabajos. Valor predeterminado: 1000 .

timeout

int

Requerido

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

Requerido

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

Requerido

Si el servidor debe devolver el client-request-id en la respuesta. Valor predeterminado: False .

ocp_date

datetime

Requerido

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.

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

valor predeterminado: True

Devoluciones

Un objeto compatible con JSON dict

Tipo de valor devuelto

dict

deserialize

Analice una cadena mediante la sintaxis restAPI y devuelva un modelo.

deserialize(data, content_type=None)

Parámetros

data

str

Requerido

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

content_type

str

valor predeterminado: None

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

Devoluciones

Instancia de este modelo

Excepciones

DeserializationError if something went wrong

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

data

dict

Requerido

Un dict mediante la estructura restAPI

content_type

str

valor predeterminado: None

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

key_extractors

valor predeterminado: None

Devoluciones

Instancia de este modelo

Excepciones

DeserializationError if something went wrong

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

keep_readonly

bool

valor predeterminado: False

Si desea serializar los atributos de solo lectura

Devoluciones

Un objeto compatible con JSON dict

Tipo de valor devuelto

dict

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

list