JobPatchParameter Classe

Ensemble de modifications à apporter à un travail.

Héritage

Model

JobPatchParameter

Constructeur

JobPatchParameter(*, priority: int = None, max_parallel_tasks: int = None, allow_task_preemption: bool = None, on_all_tasks_complete=None, constraints=None, pool_info=None, metadata=None, **kwargs)

Paramètres

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. En cas d’omission, la priorité du travail reste inchangée.

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.

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.

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é. En cas d’omission, le comportement de saisie semi-automatique reste inchangé. Vous ne pouvez pas modifier la valeur de terminatejob en noaction, c’est-à-dire qu’une fois que vous avez engagé l’arrêt automatique du travail, vous ne pouvez pas la désactiver à nouveau. Si vous essayez de le faire, la demande échoue avec une réponse d’erreur « valeur de propriété non valide » ; si vous appelez l’API REST directement, le code http status est 400 (requête incorrecte). Les valeurs possibles sont les suivantes : 'noAction', 'terminateJob'

constraints

JobConstraints

Obligatoire

Contraintes d’exécution pour le travail. En cas d’omission, les contraintes d’exécution existantes restent inchangées.

pool_info

PoolInformation

Obligatoire

Pool sur lequel le service Batch exécute les tâches du travail. Vous pouvez modifier le pool d’un travail uniquement lorsque le travail est désactivé. L’appel de travail correctif échoue si vous incluez l’élément poolInfo et si le travail n’est pas désactivé. Si vous spécifiez une autoPoolSpecification dans poolInfo, seule la propriété keepAlive de l’autoPoolSpecification peut être mise à jour, puis uniquement si l’autoPoolSpecification a un poolLifetimeOption de travail (d’autres propriétés de travail peuvent être mises à jour normalement). S’il est omis, le travail continue de s’exécuter sur son pool actuel.

metadata

list[MetadataItem]

Obligatoire

Si elles sont omises, les métadonnées de travail existantes restent inchangées.

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