Partilhar via


Schedule Classe

A agenda de acordo com as tarefas que serão criadas. Todos os tempos são corrigidos para UTC e não são afetados pela hora de verão.

Herança
Schedule

Construtor

Schedule(*, do_not_run_until=None, do_not_run_after=None, start_window=None, recurrence_interval=None, **kwargs)

Parâmetros

do_not_run_until
datetime
Necessário

Se não especificar uma hora doNotRunUntil, a agenda fica pronta para criar Tarefas imediatamente.

do_not_run_after
datetime
Necessário

Se não especificar uma hora doNotRunAfter e estiver a criar uma Agenda de Tarefas periódica, a Agenda de Tarefas permanecerá ativa até a terminar explicitamente.

start_window
<xref:timedelta>
Necessário

Se uma Tarefa não for criada no intervalo startWindow, a "oportunidade" será perdida; nenhuma Tarefa será criada até à próxima periodicidade da agenda. Se a agenda for periódica e o startWindow for maior do que o intervalo de periodicidade, isso é equivalente a um startWindow infinito, porque a Tarefa que é "devida" numa recurrenceInterval não é levada para o intervalo de periodicidade seguinte. A predefinição é infinita. O valor mínimo é 1 minuto. Se especificar um valor mais baixo, o serviço Batch rejeita a agenda com um erro; se estiver a chamar a API REST diretamente, o código de estado HTTP é 400 (Pedido Incorreto).

recurrence_interval
<xref:timedelta>
Necessário

Uma vez que uma Agenda de Tarefas pode ter, no máximo, uma Tarefa ativa sob a mesma em qualquer altura, se for altura de criar uma nova Tarefa ao abrigo de uma Agenda de Tarefas, mas a Tarefa anterior ainda estiver em execução, o serviço Batch não criará a nova Tarefa até que a Tarefa anterior seja concluída. Se a Tarefa anterior não terminar no período startWindow do novo recurrenceInterval, não será agendada nenhuma nova Tarefa para esse intervalo. Para tarefas periódicas, normalmente deve especificar um jobManagerTask na jobSpecification. Se não utilizar jobManagerTask, precisará de um processo externo para monitorizar quando as Tarefas são criadas, adicionar Tarefas aos Trabalhos e terminar as Tarefas prontas para a próxima periodicidade. A predefinição é que a agenda não se repete: é criada uma Tarefa, no startWindow após a hora doNotRunUntil, e a agenda é concluída assim que a Tarefa terminar. O valor mínimo é 1 minuto. Se especificar um valor mais baixo, o serviço Batch rejeita a agenda com um erro; se estiver a chamar a API REST diretamente, o código de estado HTTP é 400 (Pedido Incorreto).

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

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

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