Partager via

CloudJob Classe

  • Référence

Tâche Azure Batch.

Héritage
Model
CloudJob

Constructeur

CloudJob(*, id: str = None, display_name: str = None, uses_task_dependencies: bool = None, url: str = None, e_tag: str = None, last_modified=None, creation_time=None, state=None, state_transition_time=None, previous_state=None, previous_state_transition_time=None, priority: int = None, allow_task_preemption: bool = None, max_parallel_tasks: int = -1, constraints=None, job_manager_task=None, job_preparation_task=None, job_release_task=None, common_environment_settings=None, pool_info=None, on_all_tasks_complete=None, on_task_failure=None, network_configuration=None, metadata=None, execution_info=None, stats=None, **kwargs)

Paramètres

id
str
Obligatoire

L’ID respecte la casse et ne respecte pas la casse (autrement dit, il se peut que vous n’ayez pas deux ID dans un compte qui diffèrent uniquement par la casse).

display_name
str
Obligatoire
uses_task_dependencies
bool
Obligatoire

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.

url
str
Obligatoire
e_tag
str
Obligatoire

Il s’agit d’une chaîne opaque. Vous pouvez l’utiliser pour détecter si le travail a changé entre les demandes. En particulier, vous pouvez passer l’ETag lors de la mise à jour d’un travail pour spécifier que vos modifications ne doivent prendre effet que si personne d’autre n’a modifié le travail entre-temps.

last_modified
datetime
Obligatoire

Il s’agit de la dernière modification des données au niveau de la tâche, telles que l’état ou la priorité du travail. Il ne prend pas en compte les modifications au niveau des tâches, telles que l’ajout de nouvelles tâches ou le changement d’état des tâches.

creation_time
datetime
Obligatoire
state
str ou JobState
Obligatoire

État actuel du travail. Les valeurs possibles sont les suivantes : 'active', 'désactivation', 'disabled', 'enabling', 'terminateting', 'completed', 'suppression'

state_transition_time
datetime
Obligatoire
previous_state
str ou JobState
Obligatoire

État précédent du travail. Cette propriété n’est pas définie si le travail est dans son état initial Actif. Les valeurs possibles sont les suivantes : 'active', 'désactivation', 'disabled', 'enabling', 'terminateting', 'completed', 'suppression'

previous_state_transition_time
datetime
Obligatoire

Cette propriété n’est pas définie si le travail est dans son état initial Actif.

priority
int
Obligatoire

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.

allow_task_preemption
bool
Obligatoire

Indique si les tâches de ce travail peuvent être préemptées par d’autres travaux hautement prioritaires. Si la valeur est définie sur True, d’autres travaux à priorité élevée soumis au système seront prioritaires et pourront renvoyer les tâches de ce travail. Vous pouvez mettre à jour l’objet allowTaskPreemption d’un travail une fois qu’il a été créé à l’aide de l’API de travail de mise à jour.

max_parallel_tasks
int
Obligatoire

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’y a aucune limite au nombre de tâches pouvant être exécutées simultanément. Vous pouvez mettre à jour maxParallelTasks d’un travail une fois qu’il a été créé à l’aide de l’API de travail de mise à jour. Valeur par défaut : -1 .

constraints
JobConstraints
Obligatoire

Contraintes d’exécution pour le travail.

job_manager_task
JobManagerTask
Obligatoire

Détails d’une tâche du Gestionnaire de tâches à lancer au démarrage du travail.

job_preparation_task
JobPreparationTask
Obligatoire

Tâche de préparation du travail. La tâche de préparation du travail est une exécution de tâche spéciale sur chaque nœud de calcul avant toute autre tâche du travail.

job_release_task
JobReleaseTask
Obligatoire

Tâche de mise en production du travail. La tâche de mise en production du travail est une exécution de tâche spéciale à la fin du travail sur chaque nœud de calcul qui a exécuté une autre tâche du travail.

common_environment_settings
list[EnvironmentSetting]
Obligatoire

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

Paramètres du pool associés au travail.

on_all_tasks_complete
str ou OnAllTasksComplete
Obligatoire

Action que le service Batch doit effectuer lorsque toutes les tâches du travail sont à l’état terminé. La valeur par défaut est noaction. Les valeurs possibles sont les suivantes : 'noAction', 'terminateJob'

on_task_failure
str ou OnTaskFailure
Obligatoire

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 de défaillance d’une erreurInfo. Une valeur failureInfo est définie si la tâche se termine avec un code de sortie non nul 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'

network_configuration
JobNetworkConfiguration
Obligatoire

Configuration réseau du travail.

metadata
list[MetadataItem]
Obligatoire

Le service Batch n’attribue aucune signification aux métadonnées ; il s’agit uniquement de l’utilisation du code utilisateur.

execution_info
JobExecutionInformation
Obligatoire

Informations d’exécution pour le travail.

stats
JobStatistics
Obligatoire

Statistiques d’utilisation des ressources pour toute la durée de vie du travail. Cette propriété est renseignée uniquement si la tâche CloudJob a été récupérée avec une clause de développement incluant l’attribut « stats » ; sinon, elle est null. Les statistiques peuvent ne pas être disponibles immédiatement. Le service Batch effectue un cumul périodique des statistiques. Le délai classique est d’environ 30 minutes.

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