Partager via

StartTaskInformation Classe

  • Référence

Informations sur un StartTask en cours d’exécution sur un nœud de calcul.

Tous les paramètres requis doivent être renseignés pour pouvoir être envoyés à Azure.

Héritage
Model
StartTaskInformation

Constructeur

StartTaskInformation(*, state, start_time, retry_count: int, end_time=None, exit_code: int = None, container_info=None, failure_info=None, last_retry_time=None, result=None, **kwargs)

Paramètres

state
str ou StartTaskState
Obligatoire

Obligatoire. Les valeurs possibles sont les suivantes : 'running', 'completed'

start_time
datetime
Obligatoire

Obligatoire. Cette valeur est réinitialisée chaque fois que la tâche est redémarrée ou retentée (autrement dit, il s’agit de l’heure la plus récente à laquelle starttask a commencé à s’exécuter).

end_time
datetime
Obligatoire

Il s’agit de l’heure de fin de l’exécution la plus récente de StartTask, si cette exécution est terminée (même si cette exécution a échoué et qu’une nouvelle tentative est en attente). Cet élément n’est pas présent si StartTask est en cours d’exécution.

exit_code
int
Obligatoire

Code de sortie du programme spécifié sur la ligne de commande StartTask. Cette propriété est définie uniquement si l’état StartTask est terminé. En général, le code de sortie d’un processus reflète la convention spécifique implémentée par le développeur d’application pour ce processus. Si vous utilisez la valeur du code de sortie pour prendre des décisions dans votre code, veillez à connaître la convention du code de sortie utilisée par le processus d’application. Toutefois, si le service Batch met fin à StartTask (en raison du délai d’expiration ou de l’arrêt de l’utilisateur via l’API), vous pouvez voir un code de sortie défini par le système d’exploitation.

container_info
TaskContainerExecutionInformation
Obligatoire

Informations sur le conteneur sous lequel la tâche s’exécute. Cette propriété est définie uniquement si la tâche s’exécute dans un contexte de conteneur.

failure_info
TaskFailureInformation
Obligatoire

Informations décrivant l’échec de la tâche, le cas échéant. Cette propriété est définie uniquement si la tâche est à l’état terminé et a rencontré un échec.

retry_count
int
Obligatoire

Obligatoire. Nombre de fois où la tâche a été retentée par le service Batch. Les échecs d’application de tâche (code de sortie non nul) sont retentés, les erreurs de prétraitement (la tâche n’a pas pu être exécutée) et les erreurs de chargement de fichiers ne sont pas retentées. Le service Batch effectue une nouvelle tentative de la tâche jusqu’à la limite spécifiée par les contraintes.

last_retry_time
datetime
Obligatoire

Cet élément n’est présent que si la tâche a été retentée (c’est-à-dire que retryCount est différent de zéro). S’il est présent, cela est généralement identique à startTime, mais peut être différent si la tâche a été redémarrée pour des raisons autres que de réessayer ; par exemple, si le nœud de calcul a été redémarré lors d’une nouvelle tentative, le startTime est mis à jour, mais le lastRetryTime ne l’est pas.

result
str ou TaskExecutionResult
Obligatoire

Résultat de l’exécution de la tâche. Si la valeur est « failed », les détails de l’échec se trouvent dans la propriété failureInfo. Les valeurs possibles sont les suivantes : 'success', 'failure'

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