JobAddParameter Classe
Tâche Azure Batch à ajouter.
Tous les paramètres requis doivent être renseignés pour pouvoir être envoyés à Azure.
- Héritage
-
JobAddParameter
Constructeur
JobAddParameter(*, id: str, pool_info, display_name: str = None, priority: int = None, max_parallel_tasks: int = -1, allow_task_preemption: bool = None, constraints=None, job_manager_task=None, job_preparation_task=None, job_release_task=None, common_environment_settings=None, on_all_tasks_complete=None, on_task_failure=None, metadata=None, uses_task_dependencies: bool = None, network_configuration=None, **kwargs)Paramètres
- id
- str
Obligatoire. L’ID peut contenir n’importe quelle combinaison de caractères alphanumériques, y compris des traits d’union et des traits de soulignement, et ne peut pas contenir plus de 64 caractères. L’ID est respectant la casse et ne respecte pas la casse (autrement dit, vous n’avez peut-être pas deux ID dans un compte qui diffèrent uniquement par la casse).
- display_name
- str
Le nom d’affichage n’a pas besoin d’être unique et peut contenir des caractères Unicode d’une longueur maximale de 1 024.
- priority
- int
Priorité du travail. Les valeurs de priorité peuvent être comprises entre -1000 et 1000, -1 000 étant la priorité la plus basse et 1000 la plus haute. La valeur par défaut est 0.
- max_parallel_tasks
- int
Nombre maximal de tâches pouvant être exécutées en parallèle pour le travail. La valeur de maxParallelTasks doit être -1 ou supérieure à 0 si elle est spécifiée. Si elle n’est pas spécifiée, la valeur par défaut est -1, ce qui signifie qu’il n’existe aucune limite au nombre de tâches pouvant être exécutées simultanément. Vous pouvez mettre à jour maxParallelTasks d’un travail après sa création à l’aide de l’API de travail de mise à jour. Valeur par défaut : -1 .
- allow_task_preemption
- bool
Indique si les tâches de ce travail peuvent être préemptées par d’autres travaux de haute priorité. Si la valeur est définie sur True, d’autres travaux de priorité élevée soumis au système sont prioritaires et peuvent mettre de nouveau les tâches en file d’attente à partir de ce travail. Vous pouvez mettre à jour l’objet allowTaskPreemption d’un travail après sa création à l’aide de l’API de travail de mise à jour.
- job_manager_task
- JobManagerTask
Détails d’une tâche du Gestionnaire de travaux à lancer au démarrage du travail. Si le travail ne spécifie pas de tâche du gestionnaire de travaux, l’utilisateur doit ajouter explicitement des tâches au travail. Si le travail spécifie une tâche du gestionnaire de travaux, le service Batch crée la tâche du gestionnaire de travaux lors de sa création et tente de planifier la tâche du gestionnaire de travaux avant de planifier d’autres tâches dans le travail. L’objectif classique de la tâche du Gestionnaire de travaux est de contrôler et/ou surveiller l’exécution du travail, par exemple en choisissant les tâches supplémentaires à exécuter, en déterminant quand le travail est terminé, etc. (Toutefois, une tâche du gestionnaire de travaux n’est pas limitée à ces activités : il s’agit d’une tâche à part entière dans le système et d’effectuer toutes les actions requises pour le travail.) Par exemple, une tâche du Gestionnaire de travaux peut télécharger un fichier spécifié en tant que paramètre, analyser le contenu de ce fichier et envoyer des tâches supplémentaires en fonction de ce contenu.
- job_preparation_task
- JobPreparationTask
Tâche de préparation du travail. Si un travail a une tâche de préparation de travail, le service Batch exécute la tâche de préparation du travail sur un nœud avant de démarrer les tâches de ce travail sur ce nœud de calcul.
- job_release_task
- JobReleaseTask
Tâche de mise en production du travail. Une tâche de mise en production de travail ne peut pas être spécifiée sans spécifier également une tâche de préparation du travail pour le travail. Le service Batch exécute la tâche de mise en production du travail sur les nœuds qui ont exécuté la tâche de préparation du travail. L’objectif principal de la tâche de mise en production est d’annuler les modifications apportées aux nœuds de calcul par la tâche de préparation du travail. Les exemples d’activités incluent la suppression de fichiers locaux ou l’arrêt des services qui ont été démarrés dans le cadre de la préparation du travail.
- common_environment_settings
- list[EnvironmentSetting]
Les tâches individuelles peuvent remplacer un paramètre d’environnement spécifié ici en spécifiant le même nom de paramètre avec une valeur différente.
- pool_info
- PoolInformation
Obligatoire. Pool sur lequel le service Batch exécute les tâches du travail.
- on_all_tasks_complete
- str ou OnAllTasksComplete
Action que le service Batch doit effectuer lorsque toutes les tâches du travail sont à l’état terminé. Notez que si un travail ne contient aucune tâche, toutes les tâches sont considérées comme terminées. Cette option est donc le plus couramment utilisée avec une tâche gestionnaire de travaux ; Si vous souhaitez utiliser l’arrêt automatique des travaux sans gestionnaire de travaux, vous devez initialement définir onAllTasksComplete sur noaction et mettre à jour les propriétés du travail pour définir onAllTasksComplete sur terminatejob une fois que vous avez terminé l’ajout de Tâches. La valeur par défaut est noaction. Les valeurs possibles sont les suivantes : « noAction », « terminateJob »
- on_task_failure
- str ou OnTaskFailure
Action que le service Batch doit effectuer en cas d’échec d’une tâche dans le travail. Une tâche est considérée comme ayant échoué en cas d’échecInfo. Une valeur failureInfo est définie si la tâche se termine avec un code de sortie différent de zéro après avoir épuisé son nombre de nouvelles tentatives, ou s’il y a eu une erreur au démarrage de la tâche, par exemple en raison d’une erreur de téléchargement de fichier de ressources. La valeur par défaut est noaction. Les valeurs possibles sont les suivantes : « noAction », « performExitOptionsJobAction »
- metadata
- list[MetadataItem]
Le service Batch n’attribue aucune signification aux métadonnées ; il s’agit uniquement de l’utilisation du code utilisateur.
- uses_task_dependencies
- bool
Indique si les tâches du travail peuvent définir des dépendances les unes sur les autres. La valeur par défaut est false.
Méthodes
| as_dict |
Retourne un dictée 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 un 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 dans cet objet. La chaîne retournée sera utilisée pour sérialiser la clé. Si le type de retour est une liste, cela est considéré comme un dicté de résultat hiérarchique. Consultez les trois exemples de ce fichier :
Si vous souhaitez une sérialisation XML, vous pouvez passer les kwargs is_xml=True. |
| deserialize |
Analysez un str à l’aide de la syntaxe RestAPI et retournez un modèle. |
| enable_additional_properties_sending | |
| from_dict |
L’analyse d’un 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 une 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ée 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 un 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 dans cet objet.
La chaîne retournée sera utilisée pour sérialiser la clé. Si le type de retour est une liste, cela 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 une 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
Retours
Objet compatible JSON de dict
Type de retour
deserialize
Analysez un str à l’aide de la syntaxe RestAPI et retournez un modèle.
deserialize(data, content_type=None)Paramètres
Retours
Une instance de ce modèle
Exceptions
enable_additional_properties_sending
enable_additional_properties_sending()from_dict
L’analyse d’un 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
- key_extractors
Retours
Une instance de ce modèle
Exceptions
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 une sérialisation XML, vous pouvez passer les kwargs is_xml=True.
serialize(keep_readonly=False, **kwargs)Paramètres
Retours
Objet compatible JSON de dict
Type de retour
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
Azure SDK for Python