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

JobListFromJobScheduleOptions Класс

  • Ссылка

Дополнительные параметры для операции list_from_job_schedule.

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

Конструктор

JobListFromJobScheduleOptions(*, 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)

Параметры

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

Предложение $filter OData. Дополнительные сведения о создании этого фильтра см. в разделе https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-jobs-in-a-job-schedule.

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

Предложение OData $select.

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

Предложение $expand OData.

max_results
int
Обязательно

Максимальное количество элементов, возвращаемых в ответе. Можно вернуть не более 1000 заданий. Значение по умолчанию: 1000 .

timeout
int
Обязательно

Максимальное время, которое сервер может потратить на обработку запроса, в секундах. По умолчанию это 30 секунд. Значение по умолчанию: 30 .

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

Удостоверение запроса, созданное вызывающим абонентом, в виде GUID без оформления, например фигурные скобки, например 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

return_client_request_id
bool
Обязательно

Должен ли сервер возвращать идентификатор client-request-id в ответе. Значение по умолчанию: False.

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

Время выдачи запроса. Клиентские библиотеки обычно устанавливают текущее системное время; задайте его явным образом, если вы вызываете REST API напрямую.

Методы

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