JobAddParameter Třída

  • Reference

Úloha Azure Batch, která se má přidat.

Aby bylo možné odesílat do Azure, musí být vyplněny všechny požadované parametry.

Dědičnost
Model
JobAddParameter

Konstruktor

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)

Parametry

id
str
Vyžadováno

Povinná hodnota. ID může obsahovat libovolnou kombinaci alfanumerických znaků včetně spojovníků a podtržítků a nesmí obsahovat více než 64 znaků. ID zachovává malá a velká písmena a nerozlišuje velká a malá písmena (to znamená, že v rámci účtu nemusíte mít dvě ID, která se liší pouze velikostí písmen).

display_name
str
Vyžadováno

Zobrazovaný název nemusí být jedinečný a může obsahovat jakékoli znaky Unicode až do maximální délky 1024.

priority
int
Vyžadováno

Priorita úlohy. Hodnoty priority mohou být v rozsahu od -1000 do 1000, přičemž -1000 je nejnižší prioritou a 1000 nejvyšší prioritou. Výchozí hodnota je 0.

max_parallel_tasks
int
Vyžadováno

Maximální počet úkolů, které lze pro úlohu provést paralelně. Hodnota maxParallelTasks musí být -1 nebo větší než 0, pokud je zadaná. Pokud není zadaný, výchozí hodnota je -1, což znamená, že počet úloh, které je možné spustit najednou, není nijak omezený. Po vytvoření úlohy pomocí rozhraní API úlohy aktualizace můžete aktualizovat hodnotu maxParallelTasks. Výchozí hodnota: -1 .

allow_task_preemption
bool
Vyžadováno

Určuje, zda mohou být úkoly v této úloze zrušeny jinými úlohami s vysokou prioritou. Pokud je hodnota nastavená na True, budou mít přednost jiné úlohy s vysokou prioritou odeslané do systému a budou moct z této úlohy znovu vytvořit frontu úkolů. Úlohu allowTaskPreemption můžete po vytvoření aktualizovat pomocí rozhraní API úlohy aktualizace.

constraints
JobConstraints
Vyžadováno

Omezení provádění úlohy.

job_manager_task
JobManagerTask
Vyžadováno

Podrobnosti o úkolu Správce úloh, který se má spustit při spuštění úlohy. Pokud úloha neurčila úkol Správce úloh, musí uživatel do úlohy explicitně přidat úkoly. Pokud úloha určuje úkol Správce úloh, služba Batch vytvoří při vytváření úlohy úkol správce úloh a pokusí se naplánovat úkol správce úloh před plánováním jiných úkolů v úloze. Typickým účelem úlohy Správce úloh je řízení a/nebo monitorování provádění úloh, například rozhodnutí, jaké další úkoly se mají spustit, určení, kdy je práce dokončena atd. (Úkol Správce úloh se ale neomezuje na tyto aktivity – jedná se o plnohodnotný úkol v systému, který provádí akce, které jsou pro úlohu potřeba.) Úloha správce úloh může například stáhnout soubor určený jako parametr, analyzovat obsah tohoto souboru a na základě tohoto obsahu odeslat další úkoly.

job_preparation_task
JobPreparationTask
Vyžadováno

Úkol přípravy úlohy. Pokud má úloha úkol přípravy úlohy, služba Batch spustí úkol přípravy úlohy na uzlu před spuštěním libovolného úkolu této úlohy na daném výpočetním uzlu.

job_release_task
JobReleaseTask
Vyžadováno

Úloha uvolnění úlohy. Úkol uvolnění úlohy nelze zadat bez zadání úkolu přípravy úlohy pro úlohu. Služba Batch spustí úlohu uvolnění úlohy na uzlech, na kterých byla spuštěna úloha přípravy úlohy. Primárním účelem úkolu uvolnění úlohy je vrátit zpět změny výpočetních uzlů provedené úkolem přípravy úlohy. Mezi příklady aktivit patří odstranění místních souborů nebo vypnutí služeb, které byly spuštěny v rámci přípravy úlohy.

common_environment_settings
list[EnvironmentSetting]
Vyžadováno

Jednotlivé úlohy můžou přepsat nastavení prostředí zadané zde zadáním stejného názvu nastavení s jinou hodnotou.

pool_info
PoolInformation
Vyžadováno

Povinná hodnota. Fond, ve kterém služba Batch spouští úkoly úlohy.

on_all_tasks_complete
str nebo OnAllTasksComplete
Vyžadováno

Akce, kterou by služba Batch měla provést, když jsou všechny úkoly v úloze v dokončeném stavu. Všimněte si, že pokud úloha neobsahuje žádné úkoly, považují se všechny úkoly za dokončené. Tato možnost se proto nejčastěji používá u úlohy Správce úloh; Pokud chcete použít automatické ukončení úlohy bez Správce úloh, měli byste nejprve nastavit parametr onAllTasksComplete na noaction a aktualizovat vlastnosti úlohy tak, aby nastavily onAllTasksComplete na terminatejob, jakmile přidávání úkolů dokončíte. Výchozí hodnota je noaction. Mezi možné hodnoty patří: 'noAction', 'terminateJob'

on_task_failure
str nebo OnTaskFailure
Vyžadováno

Akce, kterou by služba Batch měla provést, když některý úkol v úloze selže. Úloha se považuje za neúspěšnou, pokud má failureInfo. FailureInfo se nastaví, pokud se úloha dokončí s nenulovým ukončovacím kódem po vyčerpání počtu opakování nebo pokud došlo k chybě při spuštění úlohy, například kvůli chybě při stahování souboru zdroje. Výchozí hodnota je noaction. Mezi možné hodnoty patří: 'noAction', 'performExitOptionsJobAction'

metadata
list[MetadataItem]
Vyžadováno

Služba Batch nepřiřazuje metadatům žádný význam; slouží výhradně k použití uživatelského kódu.

uses_task_dependencies
bool
Vyžadováno

Určuje, jestli úkoly v úloze můžou definovat vzájemné závislosti. Výchozí hodnotou je hodnota false.

network_configuration
JobNetworkConfiguration
Vyžadováno

Konfigurace sítě pro úlohu.

Metody

as_dict

Vrácení diktování, které může být JSONify pomocí json.dump.

Rozšířené použití může jako parametr volitelně použít zpětné volání:

Klíč je název atributu, který se používá v Pythonu. Attr_desc je dikt metadat. Aktuálně obsahuje 'type' s typem msrest a 'key' s klíčem kódovaným RestAPI. Value je aktuální hodnota v tomto objektu.

Vrácený řetězec se použije k serializaci klíče. Pokud je návratovým typem seznam, považuje se to za hierarchický dikt výsledku.

Podívejte se na tři příklady v tomto souboru:

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

Pokud chcete serializaci XML, můžete předat kwargs is_xml=True.
deserialize

Parsujte str pomocí syntaxe RestAPI a vraťte model.
enable_additional_properties_sending
from_dict

Parsování diktování pomocí daného extraktoru klíčů vrátí model.

Ve výchozím nastavení zvažte extraktory klíčů (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor a last_rest_key_case_insensitive_extractor).
is_xml_model
serialize

Vrátí kód JSON, který se z tohoto modelu odešle do Azure.

Toto je alias pro as_dict(full_restapi_key_transformer, keep_readonly=False).

Pokud chcete serializaci XML, můžete předat kwargs is_xml=True.
validate

Rekurzivně ověřte tento model a vraťte seznam ValidationError.

as_dict

Vrácení diktování, které může být JSONify pomocí json.dump.

Rozšířené použití může jako parametr volitelně použít zpětné volání:

Klíč je název atributu, který se používá v Pythonu. Attr_desc je dikt metadat. Aktuálně obsahuje 'type' s typem msrest a 'key' s klíčem kódovaným RestAPI. Value je aktuální hodnota v tomto objektu.

Vrácený řetězec se použije k serializaci klíče. Pokud je návratovým typem seznam, považuje se to za hierarchický dikt výsledku.

Podívejte se na tři příklady v tomto souboru:

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

Pokud chcete serializaci XML, můžete předat kwargs is_xml=True.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Parametry

key_transformer
<xref:function>

Funkce klíčového transformátoru.

keep_readonly
výchozí hodnota: True

Návraty

Objekt kompatibilní se dict JSON

Návratový typ

dict

deserialize

Parsujte str pomocí syntaxe RestAPI a vraťte model.

deserialize(data, content_type=None)

Parametry

data
str
Vyžadováno

Str využívající strukturu RestAPI. Json ve výchozím nastavení.

content_type
str
výchozí hodnota: None

Ve výchozím nastavení JSON nastavte application/xml, pokud XML.

Návraty

Instance tohoto modelu

Výjimky

DeserializationError if something went wrong

enable_additional_properties_sending 

enable_additional_properties_sending()

from_dict

Parsování diktování pomocí daného extraktoru klíčů vrátí model.

Ve výchozím nastavení zvažte extraktory klíčů (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor a last_rest_key_case_insensitive_extractor).

from_dict(data, key_extractors=None, content_type=None)

Parametry

data
dict
Vyžadováno

A dict using RestAPI structure

content_type
str
výchozí hodnota: None

Ve výchozím nastavení JSON nastavte application/xml, pokud XML.

key_extractors
výchozí hodnota: None

Návraty

Instance tohoto modelu

Výjimky

DeserializationError if something went wrong

is_xml_model 

is_xml_model()

serialize

Vrátí kód JSON, který se z tohoto modelu odešle do Azure.

Toto je alias pro as_dict(full_restapi_key_transformer, keep_readonly=False).

Pokud chcete serializaci XML, můžete předat kwargs is_xml=True.

serialize(keep_readonly=False, **kwargs)

Parametry

keep_readonly
bool
výchozí hodnota: False

Pokud chcete serializovat atributy readonly

Návraty

Objekt kompatibilní se dict JSON

Návratový typ

dict

validate

Rekurzivně ověřte tento model a vraťte seznam ValidationError.

validate()

Návraty

Seznam chyb ověření

Návratový typ

list