Partager via

Schedule Classe

  • Référence

Planification en fonction de laquelle les travaux seront créés. Toutes les heures sont fixes respectivement à UTC et ne sont pas affectées par l’heure d’été.

Héritage
Model
Schedule

Constructeur

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

Paramètres

do_not_run_until
datetime
Obligatoire

Si vous ne spécifiez pas d’heure doNotRunUntil, la planification est prête à créer des travaux immédiatement.

do_not_run_after
datetime
Obligatoire

Si vous ne spécifiez pas d’heure doNotRunAfter et que vous créez une planification de travail périodique, la planification du travail reste active jusqu’à ce que vous l’arrêtiez explicitement.

start_window
<xref:timedelta>
Obligatoire

Si un travail n’est pas créé dans l’intervalle startWindow, l'« opportunité » est perdue ; aucune tâche n’est créée jusqu’à la prochaine périodicité de la planification. Si la planification est périodique et que le startWindow est plus long que l’intervalle de périodicité, cela équivaut à un startWindow infini, car la tâche « due » dans une périodicitéInterval n’est pas reportée dans l’intervalle de périodicité suivant. La valeur par défaut est infini. La valeur minimale est 1 minute. Si vous spécifiez une valeur inférieure, le service Batch rejette la planification avec une erreur ; si vous appelez l’API REST directement, le code http status est 400 (requête incorrecte).

recurrence_interval
<xref:timedelta>
Obligatoire

Étant donné qu’une planification de travail peut avoir tout au plus un travail actif sous elle à un moment donné, s’il est temps de créer un nouveau travail sous une planification de travail, mais que le travail précédent est toujours en cours d’exécution, le service Batch ne crée pas le nouveau travail tant que le travail précédent n’est pas terminé. Si le travail précédent ne se termine pas pendant la période startWindow de la nouvelle périodicitéInterval, aucun nouveau travail n’est planifié pour cet intervalle. Pour les travaux périodiques, vous devez normalement spécifier un jobManagerTask dans le jobSpecification. Si vous n’utilisez pas jobManagerTask, vous aurez besoin d’un processus externe pour surveiller la création de travaux, ajouter des tâches aux travaux et mettre fin aux travaux prêts pour la périodicité suivante. La valeur par défaut est que la planification ne se répète pas : un travail est créé, dans le startWindow après l’heure doNotRunUntil, et la planification est terminée dès la fin de ce travail. La valeur minimale est 1 minute. Si vous spécifiez une valeur inférieure, le service Batch rejette la planification avec une erreur ; si vous appelez l’API REST directement, le code http status est 400 (requête incorrecte).

Méthodes

as_dict

Retourne un dict qui peut être JSONify à l’aide de json.dump.

L’utilisation avancée peut éventuellement utiliser un rappel comme paramètre :

La clé est le nom d’attribut utilisé dans Python. Attr_desc est une dictée de métadonnées. Contient actuellement « type » avec le type msrest et « key » avec la clé encodée RestAPI. Value est la valeur actuelle de cet objet.

La chaîne retournée sera utilisée pour sérialiser la clé. Si le type de retour est une liste, il est considéré comme un dict de résultat hiérarchique.

Consultez les trois exemples de ce fichier :

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

Si vous souhaitez la sérialisation XML, vous pouvez passer les kwargs is_xml=True.
deserialize

Analysez une str à l’aide de la syntaxe RestAPI et retournez un modèle.
enable_additional_properties_sending
from_dict

Analyser une dict à l’aide de l’extracteur de clé donné retourne un modèle.

Par défaut, considérez les extracteurs de clés (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor et last_rest_key_case_insensitive_extractor)
is_xml_model
serialize

Retourne le json qui serait envoyé à Azure à partir de ce modèle.

Il s’agit d’un alias pour as_dict(full_restapi_key_transformer, keep_readonly=False).

Si vous souhaitez la sérialisation XML, vous pouvez passer les kwargs is_xml=True.
validate

Validez ce modèle de manière récursive et retournez une liste de ValidationError.

as_dict

Retourne un dict qui peut être JSONify à l’aide de json.dump.

L’utilisation avancée peut éventuellement utiliser un rappel comme paramètre :

La clé est le nom d’attribut utilisé dans Python. Attr_desc est une dictée de métadonnées. Contient actuellement « type » avec le type msrest et « key » avec la clé encodée RestAPI. Value est la valeur actuelle de cet objet.

La chaîne retournée sera utilisée pour sérialiser la clé. Si le type de retour est une liste, il est considéré comme un dict de résultat hiérarchique.

Consultez les trois exemples de ce fichier :

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

Si vous souhaitez la sérialisation XML, vous pouvez passer les kwargs is_xml=True.

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

Paramètres

key_transformer
<xref:function>

Fonction de transformateur de clé.

keep_readonly
valeur par défaut: True

Retours

Objet compatible JSON dict

Type de retour

dict

deserialize

Analysez une str à l’aide de la syntaxe RestAPI et retournez un modèle.

deserialize(data, content_type=None)

Paramètres

data
str
Obligatoire

Str utilisant la structure RestAPI. JSON par défaut.

content_type
str
valeur par défaut: None

JSON par défaut, définissez application/xml si XML.

Retours

Une instance de ce modèle

Exceptions

DeserializationError if something went wrong

enable_additional_properties_sending 

enable_additional_properties_sending()

from_dict

Analyser une dict à l’aide de l’extracteur de clé donné retourne un modèle.

Par défaut, considérez les extracteurs de clés (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor et last_rest_key_case_insensitive_extractor)

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

Paramètres

data
dict
Obligatoire

dict utilisant la structure RestAPI

content_type
str
valeur par défaut: None

JSON par défaut, définissez application/xml si XML.

key_extractors
valeur par défaut: None

Retours

Une instance de ce modèle

Exceptions

DeserializationError if something went wrong

is_xml_model 

is_xml_model()

serialize

Retourne le json qui serait envoyé à Azure à partir de ce modèle.

Il s’agit d’un alias pour as_dict(full_restapi_key_transformer, keep_readonly=False).

Si vous souhaitez la sérialisation XML, vous pouvez passer les kwargs is_xml=True.

serialize(keep_readonly=False, **kwargs)

Paramètres

keep_readonly
bool
valeur par défaut: False

Si vous souhaitez sérialiser les attributs readonly

Retours

Objet compatible JSON dict

Type de retour

dict

validate

Validez ce modèle de manière récursive et retournez une liste de ValidationError.

validate()

Retours

Liste des erreurs de validation

Type de retour

list