Compartilhar via

JobResponse Classe

  • Referência

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
Obrigatório

Sistema gerado. Ignorado na criação. O identificador exclusivo do trabalho.

query_condition
str
Obrigatório

A condição de consulta do dispositivo.

created_time
datetime
Obrigatório

Sistema gerado. Ignorado na criação. A data e a hora de criação do trabalho.

start_time
datetime
Obrigatório

A data e a hora de início do trabalho agendado em UTC.

end_time
datetime
Obrigatório

Sistema gerado. Ignorado na criação. A data e a hora de término do trabalho em UTC.

max_execution_time_in_seconds
<xref:long>
Obrigatório

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

type
str ou <xref:protocol.models.enum>
Obrigatório

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

cloud_to_device_method
CloudToDeviceMethod
Obrigatório

O tipo de método e os parâmetros. Isso será necessário se o tipo de trabalho for cloudToDeviceMethod.

update_twin
Twin
Obrigatório
status
str ou <xref:protocol.models.enum>
Obrigatório

Sistema gerado. Ignorado na criação. O status do trabalho. Os valores possíveis incluem: 'unknown', 'enqueued', 'running', 'completed', 'failed', 'cancelled', 'scheduled', 'enfileirado'

failure_reason
str
Obrigatório

O motivo da falha, se ocorreu uma falha.

status_message
str
Obrigatório

A mensagem status do trabalho.

device_job_statistics
DeviceJobStatistics
Obrigatório

Os detalhes sobre a execução do trabalho status.

Métodos

as_dict

Retornar um ditado que pode ser JSONify usando json.dump.

Opcionalmente, o uso avançado pode usar um retorno de chamada como parâmetro:

Key é o nome do atributo usado no Python. Attr_desc é um dict de metadados. Atualmente contém 'type' com o tipo msrest e 'key' com a chave codificada restAPI. Value é o valor atual neste objeto .

A cadeia de caracteres retornada será usada para serializar a chave. Se o tipo de retorno for uma lista, isso será considerado um dict de resultado hierárquico.

Confira os três exemplos neste arquivo:

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

Se você quiser serialização XML, poderá passar os kwargs is_xml=True.
deserialize

Analise um str usando a sintaxe RestAPI e retorne um modelo.
enable_additional_properties_sending
from_dict

Analisar um ditado usando determinado extrator de chave retorna um modelo.

Por padrão, considere extratores de chave (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor e last_rest_key_case_insensitive_extractor)
is_xml_model
serialize

Retorne o JSON que seria enviado para o azure desse modelo.

Esse é um alias para as_dict(full_restapi_key_transformer, keep_readonly=False).

Se você quiser serialização XML, poderá passar os kwargs is_xml=True.
validate

Valide esse modelo recursivamente e retorne uma lista de ValidationError.

as_dict

Retornar um ditado que pode ser JSONify usando json.dump.

Opcionalmente, o uso avançado pode usar um retorno de chamada como parâmetro:

Key é o nome do atributo usado no Python. Attr_desc é um dict de metadados. Atualmente contém 'type' com o tipo msrest e 'key' com a chave codificada restAPI. Value é o valor atual neste objeto .

A cadeia de caracteres retornada será usada para serializar a chave. Se o tipo de retorno for uma lista, isso será considerado um dict de resultado hierárquico.

Confira os três exemplos neste arquivo:

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

Se você quiser serialização XML, poderá 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 chave.

keep_readonly
valor padrão: True

Retornos

Um objeto compatível com JSON de dict

Tipo de retorno

dict

deserialize

Analise um str usando a sintaxe RestAPI e retorne um modelo.

deserialize(data, content_type=None)

Parâmetros

data
str
Obrigatório

Um str usando a estrutura RestAPI. JSON por padrão.

content_type
str
valor padrão: None

JSON por padrão, defina application/xml se XML.

Retornos

Uma instância desse modelo

Exceções

DeserializationError if something went wrong

enable_additional_properties_sending 

enable_additional_properties_sending()

from_dict

Analisar um ditado usando determinado extrator de chave retorna um modelo.

Por padrão, considere extratores de 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
Obrigatório

Um ditado usando a estrutura RestAPI

content_type
str
valor padrão: None

JSON por padrão, defina application/xml se XML.

key_extractors
valor padrão: None

Retornos

Uma instância desse modelo

Exceções

DeserializationError if something went wrong

is_xml_model 

is_xml_model()

serialize

Retorne o JSON que seria enviado para o azure desse modelo.

Esse é um alias para as_dict(full_restapi_key_transformer, keep_readonly=False).

Se você quiser serialização XML, poderá passar os kwargs is_xml=True.

serialize(keep_readonly=False, **kwargs)

Parâmetros

keep_readonly
bool
valor padrão: False

Se você quiser serializar os atributos somente leitura

Retornos

Um objeto compatível com JSON de dict

Tipo de retorno

dict

validate

Valide esse modelo recursivamente e retorne uma lista de ValidationError.

validate()

Retornos

Uma lista de erros de validação

Tipo de retorno

list