JobResponse Classe

JobResponse.

Herança

Model

JobResponse

Construtor

JobResponse(*, job_id: str = None, query_condition: str = None, created_time=None, start_time=None, end_time=None, max_execution_time_in_seconds: int = None, type=None, cloud_to_device_method=None, update_twin=None, status=None, failure_reason: str = None, status_message: str = None, device_job_statistics=None, **kwargs)

Parâmetros

job_id

str

Necessário

Sistema gerado. Ignorado na criação. O identificador exclusivo da tarefa.

query_condition

str

Necessário

A condição de consulta do dispositivo.

created_time

datetime

Necessário

Sistema gerado. Ignorado na criação. A data e hora de criação da tarefa.

start_time

datetime

Necessário

A data e hora de início da tarefa agendada em UTC.

end_time

datetime

Necessário

Sistema gerado. Ignorado na criação. A data e hora de fim da tarefa em UTC.

max_execution_time_in_seconds

<xref:long>

Necessário

O tempo máximo de execução em secounds.

type

str ou <xref:protocol.models.enum>

Necessário

O tipo de tarefa. Os valores possíveis incluem: "desconhecido", "export", "import", "backup", "readDeviceProperties", "writeDeviceProperties", "updateDeviceConfiguration", "rebootDevice", "factoryResetDevice", "firmwareUpdate", "scheduleDeviceMethod", "scheduleUpdateTwin", "restoreFromBackup", "failoverDataCopy"

cloud_to_device_method

CloudToDeviceMethod

Necessário

O tipo de método e os parâmetros. Isto é necessário se o tipo de tarefa for cloudToDeviceMethod.

update_twin

Twin

Necessário

status

str ou <xref:protocol.models.enum>

Necessário

Sistema gerado. Ignorado na criação. O estado da tarefa. Os valores possíveis incluem: "desconhecido", "enqueued", "em execução", "concluído", "falhado", "cancelado", "agendado", "em fila"

failure_reason

str

Necessário

O motivo da falha, se tiver ocorrido uma falha.

status_message

str

Necessário

A mensagem de estado da tarefa.

device_job_statistics

DeviceJobStatistics

Necessário

Os detalhes sobre o estado de execução da tarefa.

Métodos

as_dict	Devolva um ditado que pode ser JSONify com json.dump. Opcionalmente, a utilização avançada pode utilizar uma chamada de retorno como parâmetro: A chave é o nome do atributo utilizado no Python. Attr_desc é um ditado dos metadados. Atualmente contém "type" com o tipo msrest e "key" com a chave codificada RestAPI. Valor é o valor atual neste objeto. A cadeia devolvida será utilizada para serializar a chave. Se o tipo de retorno for uma lista, este é considerado ditado de resultado hierárquico. Veja os três exemplos neste ficheiro: attribute_transformer full_restapi_key_transformer last_restapi_key_transformer Se quiser serialização XML, pode passar os kwargs is_xml=True.
deserialize	Analise um str com a sintaxe RestAPI e devolva um modelo.
enable_additional_properties_sending
from_dict	Analisar um ditado com um determinado extrator de chaves devolve um modelo. Por predefinição, considere extratores chave (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor e last_rest_key_case_insensitive_extractor)
is_xml_model
serialize	Devolva o JSON que seria enviado para o azure a partir deste modelo. Este é um alias para as_dict(full_restapi_key_transformer, keep_readonly=Falso). Se quiser serialização XML, pode passar os kwargs is_xml=True.
validate	Valide este modelo de forma recursiva e devolva uma lista de ValidationError.

as_dict

Devolva um ditado que pode ser JSONify com json.dump.

Opcionalmente, a utilização avançada pode utilizar uma chamada de retorno como parâmetro:

A chave é o nome do atributo utilizado no Python. Attr_desc é um ditado dos metadados. Atualmente contém "type" com o tipo msrest e "key" com a chave codificada RestAPI. Valor é o valor atual neste objeto.

A cadeia devolvida será utilizada para serializar a chave. Se o tipo de retorno for uma lista, este é considerado ditado de resultado hierárquico.

Veja os três exemplos neste ficheiro:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

Se quiser serialização XML, pode passar os kwargs is_xml=True.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Parâmetros

key_transformer

<xref:function>

Uma função de transformador de chaves.

keep_readonly

valor predefinido: True

Devoluções

Um objeto compatível com JSON de dict

Tipo de retorno

dict

deserialize

Analise um str com a sintaxe RestAPI e devolva um modelo.

deserialize(data, content_type=None)

Parâmetros

data

str

Necessário

Um str com a estrutura RestAPI. JSON por predefinição.

content_type

str

valor predefinido: None

JSON por predefinição, defina aplicação/xml se XML.

Devoluções

Uma instância deste modelo

Exceções

DeserializationError if something went wrong

enable_additional_properties_sending

enable_additional_properties_sending()

from_dict

Analisar um ditado com um determinado extrator de chaves devolve um modelo.

Por predefinição, considere extratores chave (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor e last_rest_key_case_insensitive_extractor)

from_dict(data, key_extractors=None, content_type=None)

Parâmetros

data

dict

Necessário

Um ditado com a estrutura restAPI

content_type

str

valor predefinido: None

JSON por predefinição, defina aplicação/xml se XML.

key_extractors

valor predefinido: None

Devoluções

Uma instância deste modelo

Exceções

DeserializationError if something went wrong

is_xml_model

is_xml_model()

serialize

Devolva o JSON que seria enviado para o azure a partir deste modelo.

Este é um alias para as_dict(full_restapi_key_transformer, keep_readonly=Falso).

Se quiser serialização XML, pode passar os kwargs is_xml=True.

serialize(keep_readonly=False, **kwargs)

Parâmetros

keep_readonly

bool

valor predefinido: False

Se quiser serializar os atributos só de leitura

Devoluções

Um objeto compatível com JSON de dict

Tipo de retorno

dict

validate

Valide este modelo de forma recursiva e devolva uma lista de ValidationError.

validate()

Devoluções

Uma lista de erros de validação

Tipo de retorno

list