JobAddParameter Classe
Processo Azure Batch da aggiungere.
Tutti i parametri obbligatori devono essere popolati per l'invio ad Azure.
- Ereditarietà
-
JobAddParameter
Costruttore
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)
Parametri
- id
- str
Obbligatorio. L'ID può contenere qualsiasi combinazione di caratteri alfanumerici, inclusi trattini e caratteri di sottolineatura, e non può contenere più di 64 caratteri. L'ID mantiene le maiuscole e minuscole e non fa distinzione tra maiuscole e minuscole, ovvero potrebbe non avere due ID all'interno di un account che differisce solo per caso.
- display_name
- str
Il nome visualizzato non deve essere univoco e può contenere caratteri Unicode fino a una lunghezza massima di 1024.
- priority
- int
Priorità del processo. I valori della priorità possono essere compresi tra -1000 e 1000, dove -1000 è la priorità più bassa e 1000 la priorità più alta. Il valore predefinito è 0.
- max_parallel_tasks
- int
Numero massimo di attività che è possibile eseguire in parallelo per il processo. Il valore di maxParallelTasks deve essere -1 o maggiore di 0 se specificato. Se non specificato, il valore predefinito è -1, ovvero non esiste alcun limite al numero di attività che possono essere eseguite contemporaneamente. È possibile aggiornare il valore maxParallelTasks di un processo dopo che è stato creato usando l'API del processo di aggiornamento. Valore predefinito: -1 .
- allow_task_preemption
- bool
Indica se le attività in questo processo possono essere annullate da altri processi con priorità elevata. Se il valore è impostato su True, gli altri processi con priorità alta inviati al sistema avranno la precedenza e potranno rieseguere le attività da questo processo. È possibile aggiornare allowTaskPreemption di un processo dopo che è stato creato usando l'API del processo di aggiornamento.
- job_manager_task
- JobManagerTask
Dettagli di un'attività di Gestione processi da avviare all'avvio del processo. Se il processo non specifica un'attività di Gestione processi, l'utente deve aggiungere in modo esplicito attività al processo. Se il processo specifica un'attività di Gestione processi, il servizio Batch crea l'attività di Gestione processi quando viene creato il processo e tenterà di pianificare l'attività di Gestione processi prima di pianificare altre attività nel processo. Lo scopo tipico dell'attività di Gestione processi è controllare e/o monitorare l'esecuzione del processo, ad esempio decidendo quali attività aggiuntive eseguire, determinare quando il lavoro è completo e così via. Tuttavia, un'attività di Gestione processi non è limitata a queste attività. Si tratta di un'attività completamente entità nel sistema e di eseguire qualsiasi azione necessaria per il processo. Ad esempio, un'attività di Gestione processi potrebbe scaricare un file specificato come parametro, analizzare il contenuto del file e inviare attività aggiuntive in base a tali contenuti.
- job_preparation_task
- JobPreparationTask
Attività di preparazione del processo. Se un processo dispone di un'attività di preparazione processo, il servizio Batch eseguirà l'attività preparazione processo in un nodo prima di avviare qualsiasi attività del processo nel nodo di calcolo.
- job_release_task
- JobReleaseTask
Attività Rilascio processo. Non è possibile specificare un'attività di rilascio processo senza specificare anche un'attività di preparazione processo per il processo. Il servizio Batch esegue l'attività Rilascio processo nei nodi che hanno eseguito l'attività preparazione processo. Lo scopo principale dell'attività di rilascio del processo è annullare le modifiche apportate ai nodi di calcolo eseguiti dall'attività preparazione processo. Le attività di esempio includono l'eliminazione di file locali o l'arresto dei servizi avviati come parte della preparazione del processo.
- common_environment_settings
- list[EnvironmentSetting]
Le singole attività possono eseguire l'override di un'impostazione di ambiente specificata qui specificando lo stesso nome di impostazione con un valore diverso.
- pool_info
- PoolInformation
Obbligatorio. Pool in cui il servizio Batch esegue le attività del processo.
- on_all_tasks_complete
- str oppure OnAllTasksComplete
L'azione che il servizio Batch deve eseguire quando tutte le attività nel processo sono nello stato completato. Si noti che se un processo non contiene attività, tutte le attività vengono considerate complete. Questa opzione viene quindi usata più comunemente con un'attività di Gestione processi; Se si vuole usare la terminazione automatica del processo senza Gestione processi, è necessario impostare inizialmente onAllTasksComplete su noaction e aggiornare le proprietà job per impostare onAllTasksComplete su terminatejob al termine dell'aggiunta di Attività. Il valore predefinito è noaction. I valori possibili includono: 'noAction', 'terminateJob'
- on_task_failure
- str oppure OnTaskFailure
L'azione che il servizio Batch deve eseguire quando un'attività nel processo ha esito negativo. Un'attività viene considerata non riuscita se ha un valore failureInfo. Un failureInfo viene impostato se l'attività viene completata con un codice di uscita diverso da zero dopo aver esaurito il numero di tentativi oppure se si è verificato un errore durante l'avvio dell'attività, ad esempio a causa di un errore di download del file di risorse. Il valore predefinito è noaction. I valori possibili includono: 'noAction', 'performExitOptionsJobAction'
- metadata
- list[MetadataItem]
Il servizio Batch non assegna alcun significato ai metadati; è esclusivamente per l'uso del codice utente.
- uses_task_dependencies
- bool
Indica se le attività nel processo possono definire le dipendenze l'una dall'altra. Il valore predefinito è false.
Metodi
as_dict |
Restituire un dict che può essere JSONify usando json.dump. L'utilizzo avanzato può facoltativamente usare un callback come parametro: Key è il nome dell'attributo usato in Python. Attr_desc è un dict di metadati. Attualmente contiene 'type' con il tipo msrest e 'key' con la chiave con codifica RestAPI. Value è il valore corrente in questo oggetto. La stringa restituita verrà utilizzata per serializzare la chiave. Se il tipo restituito è un elenco, si tratta di un risultato gerarchico dict. Vedere i tre esempi in questo file:
Se si desidera la serializzazione XML, è possibile passare i kwargs is_xml=True. |
deserialize |
Analizzare uno str usando la sintassi RestAPI e restituire un modello. |
enable_additional_properties_sending | |
from_dict |
Analizzare un dict usando un estrattore di chiave specificato restituisce un modello. Per impostazione predefinita, considerare gli estrattori di chiave (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor e last_rest_key_case_insensitive_extractor) |
is_xml_model | |
serialize |
Restituire il codice JSON che verrebbe inviato ad Azure da questo modello. Si tratta di un alias per as_dict(full_restapi_key_transformer, keep_readonly=False). Se si desidera la serializzazione XML, è possibile passare i kwargs is_xml=True. |
validate |
Convalidare questo modello in modo ricorsivo e restituire un elenco di ValidationError. |
as_dict
Restituire un dict che può essere JSONify usando json.dump.
L'utilizzo avanzato può facoltativamente usare un callback come parametro:
Key è il nome dell'attributo usato in Python. Attr_desc è un dict di metadati. Attualmente contiene 'type' con il tipo msrest e 'key' con la chiave con codifica RestAPI. Value è il valore corrente in questo oggetto.
La stringa restituita verrà utilizzata per serializzare la chiave. Se il tipo restituito è un elenco, si tratta di un risultato gerarchico dict.
Vedere i tre esempi in questo file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
Se si desidera la serializzazione XML, è possibile passare i kwargs is_xml=True.
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)
Parametri
- key_transformer
- <xref:function>
Funzione di trasformatore di tasti.
- keep_readonly
Restituisce
Oggetto compatibile con JSON dict
Tipo restituito
deserialize
Analizzare uno str usando la sintassi RestAPI e restituire un modello.
deserialize(data, content_type=None)
Parametri
- content_type
- str
JSON per impostazione predefinita, impostare application/xml se XML.
Restituisce
Istanza di questo modello
Eccezioni
enable_additional_properties_sending
enable_additional_properties_sending()
from_dict
Analizzare un dict usando un estrattore di chiave specificato restituisce un modello.
Per impostazione predefinita, considerare gli estrattori di chiave (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor e last_rest_key_case_insensitive_extractor)
from_dict(data, key_extractors=None, content_type=None)
Parametri
- content_type
- str
JSON per impostazione predefinita, impostare application/xml se XML.
- key_extractors
Restituisce
Istanza di questo modello
Eccezioni
is_xml_model
is_xml_model()
serialize
Restituire il codice JSON che verrebbe inviato ad Azure da questo modello.
Si tratta di un alias per as_dict(full_restapi_key_transformer, keep_readonly=False).
Se si desidera la serializzazione XML, è possibile passare i kwargs is_xml=True.
serialize(keep_readonly=False, **kwargs)
Parametri
Restituisce
Oggetto compatibile con JSON dict
Tipo restituito
validate
Convalidare questo modello in modo ricorsivo e restituire un elenco di ValidationError.
validate()
Restituisce
Elenco di errori di convalida
Tipo restituito
Azure SDK for Python