Поделиться через

JobRequest Класс

  • Ссылка

JobRequest.

Наследование
Model
JobRequest

Конструктор

JobRequest(*, job_id: str = None, type=None, cloud_to_device_method=None, update_twin=None, query_condition: str = None, start_time=None, max_execution_time_in_seconds: int = None, **kwargs)

Параметры

job_id
str
Обязательно

Уникальный идентификатор задания.

type
str или <xref:protocol.models.enum>
Обязательно

Тип задания. Возможные значения: "unknown", "export", "import", "backup", "readDeviceProperties", "writeDeviceProperties", "updateDeviceConfiguration", "rebootDevice", "factoryResetDevice", "firmwareUpdate", "scheduleDeviceMethod", "scheduleUpdateTwin", "restoreFromBackup", "failoverDataCopy".

cloud_to_device_method
CloudToDeviceMethod
Обязательно

Тип и параметры метода. Это необходимо, если тип задания — cloudToDeviceMethod.

update_twin
Twin
Обязательно
query_condition
str
Обязательно

Условие для выполнения задания устройствами. Это необходимо, если тип задания — updateTwin или cloudToDeviceMethod.

start_time
datetime
Обязательно

Дата и время начала задания в стандарте ISO 8601.

max_execution_time_in_seconds
<xref:long>
Обязательно

Максимальное время выполнения в секундах.

Методы

as_dict

Возвращает словарь, который может иметь значение JSONify с помощью json.dump.

Дополнительное использование может использовать обратный вызов в качестве параметра:

Ключ — это имя атрибута, используемого в Python. Attr_desc — это диктовка метаданных. В настоящее время содержит "тип" с типом msrest и "key" с ключом в кодировке RestAPI. Значение — это текущее значение в этом объекте.

Возвращаемая строка будет использоваться для сериализации ключа. Если тип возвращаемого значения является списком, это считается иерархическим результирующим диктом.

См. три примера в этом файле:

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

Если требуется xml-сериализация, можно передать kwargs is_xml=True.
deserialize

Синтаксический анализ str с помощью синтаксиса RestAPI и возврат модели.
enable_additional_properties_sending
from_dict

Синтаксический анализ дикта с помощью заданного средства извлечения ключа возвращает модель.

По умолчанию рекомендуется использовать средства извлечения ключей (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor и last_rest_key_case_insensitive_extractor).
is_xml_model
serialize

Возвращает json, который будет отправлен в Azure из этой модели.

Это псевдоним для as_dict(full_restapi_key_transformer, keep_readonly=False).

Если требуется xml-сериализация, можно передать kwargs is_xml=True.
validate

Рекурсивная проверка этой модели и возврат списка ValidationError.

as_dict

Возвращает словарь, который может иметь значение JSONify с помощью json.dump.

Дополнительное использование может использовать обратный вызов в качестве параметра:

Ключ — это имя атрибута, используемого в Python. Attr_desc — это диктовка метаданных. В настоящее время содержит "тип" с типом msrest и "key" с ключом в кодировке RestAPI. Значение — это текущее значение в этом объекте.

Возвращаемая строка будет использоваться для сериализации ключа. Если тип возвращаемого значения является списком, это считается иерархическим результирующим диктом.

См. три примера в этом файле:

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

Если требуется xml-сериализация, можно передать kwargs is_xml=True.

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

Параметры

key_transformer
<xref:function>

Функция преобразователя ключей.

keep_readonly
значение по умолчанию: True

Возвращаемое значение

Объект, совместимый с JSON для дикта

Возвращаемый тип

dict

deserialize

Синтаксический анализ str с помощью синтаксиса RestAPI и возврат модели.

deserialize(data, content_type=None)

Параметры

data
str
Обязательно

Строка, использующий структуру RestAPI. JSON по умолчанию.

content_type
str
значение по умолчанию: None

JSON по умолчанию задайте значение application/xml if XML.

Возвращаемое значение

Экземпляр этой модели

Исключения

DeserializationError if something went wrong

enable_additional_properties_sending 

enable_additional_properties_sending()

from_dict

Синтаксический анализ дикта с помощью заданного средства извлечения ключа возвращает модель.

По умолчанию рекомендуется использовать средства извлечения ключей (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor и last_rest_key_case_insensitive_extractor).

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

Параметры

data
dict
Обязательно

Словарь, использующий структуру RestAPI

content_type
str
значение по умолчанию: None

JSON по умолчанию задайте значение application/xml if XML.

key_extractors
значение по умолчанию: None

Возвращаемое значение

Экземпляр этой модели

Исключения

DeserializationError if something went wrong

is_xml_model 

is_xml_model()

serialize

Возвращает json, который будет отправлен в Azure из этой модели.

Это псевдоним для as_dict(full_restapi_key_transformer, keep_readonly=False).

Если требуется xml-сериализация, можно передать kwargs is_xml=True.

serialize(keep_readonly=False, **kwargs)

Параметры

keep_readonly
bool
значение по умолчанию: False

Если вы хотите сериализовать атрибуты только для чтения

Возвращаемое значение

Объект, совместимый с JSON для дикта

Возвращаемый тип

dict

validate

Рекурсивная проверка этой модели и возврат списка ValidationError.

validate()

Возвращаемое значение

Список ошибок проверки

Возвращаемый тип

list