JobAddParameter Klasa
Zadanie Azure Batch do dodania.
Wszystkie wymagane parametry muszą zostać wypełnione w celu wysłania ich na platformę Azure.
- Dziedziczenie
-
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
Wymagane. Identyfikator może zawierać dowolną kombinację znaków alfanumerycznych, w tym łączników i podkreśleń, i nie może zawierać więcej niż 64 znaków. Identyfikator zachowuje wielkość liter i nie uwzględnia wielkości liter (oznacza to, że w ramach konta nie ma dwóch identyfikatorów, które różnią się tylko wielkością liter).
- display_name
- str
Nazwa wyświetlana nie musi być unikatowa i może zawierać znaki Unicode o maksymalnej długości 1024.
- priority
- int
Priorytet zadania. Wartości priorytetu mogą mieścić się w zakresie od -1000 do 1000, a wartość -1000 jest najniższym priorytetem, a 1000 jest najwyższym priorytetem. Wartość domyślna to 0.
- max_parallel_tasks
- int
Maksymalna liczba zadań, które mogą być wykonywane równolegle dla zadania. Wartość parametru maxParallelTasks musi być -1 lub większa niż 0, jeśli jest określona. Jeśli nie zostanie określona, wartość domyślna to -1, co oznacza, że nie ma limitu liczby zadań, które można uruchamiać jednocześnie. Możesz zaktualizować element maxParallelTasks zadania po jego utworzeniu przy użyciu interfejsu API zadania aktualizacji. Wartość domyślna: -1 .
- allow_task_preemption
- bool
Czy zadania podrzędne w tym zadaniu mogą zostać wywłaszczone przez inne zadania o wysokim priorytcie. Jeśli wartość jest ustawiona na True, inne zadania o wysokim priorytcie przesłane do systemu będą miały pierwszeństwo i będą mogły ponownie kolejkować zadania z tego zadania. Możesz zaktualizować parametr allowTaskPreemption zadania po jego utworzeniu przy użyciu interfejsu API zadania aktualizacji.
- job_manager_task
- JobManagerTask
Szczegółowe informacje o zadaniu Menedżera zadań, które ma zostać uruchomione po uruchomieniu zadania. Jeśli zadanie nie określi zadania Menedżera zadań, użytkownik musi jawnie dodać zadania do zadania. Jeśli zadanie określi zadanie Menedżera zadań, usługa Batch utworzy zadanie Menedżera zadań podczas tworzenia zadania i spróbuje zaplanować zadanie Menedżera zadań przed zaplanowaniem innych zadań w zadaniu. Typowym celem zadania Menedżera zadań jest kontrolowanie i/lub monitorowanie wykonywania zadania, na przykład poprzez podjęcie decyzji o tym, jakie dodatkowe zadania należy uruchomić, określając, kiedy praca jest zakończona itp. (Jednak zadanie Menedżera zadań nie jest ograniczone do tych działań — jest to w pełni funkcjonalne zadanie w systemie i wykonywanie jakichkolwiek czynności wymaganych dla zadania). Na przykład zadanie Menedżera zadań może pobrać plik określony jako parametr, przeanalizować zawartość tego pliku i przesłać dodatkowe zadania na podstawie tej zawartości.
- job_preparation_task
- JobPreparationTask
Zadanie przygotowania zadania. Jeśli zadanie ma zadanie przygotowania zadania, usługa Batch uruchomi zadanie przygotowania zadania w węźle przed uruchomieniem jakichkolwiek zadań tego zadania w tym węźle obliczeniowym.
- job_release_task
- JobReleaseTask
Zadanie zwolnienia zadania. Nie można określić zadania zwolnienia zadania bez określania zadania podrzędnego przygotowania zadania. Usługa Batch uruchamia zadanie zwolnienia zadania w węzłach, w których uruchomiono zadanie przygotowania zadania. Głównym celem zadania zwolnienia zadania jest cofnięcie zmian w węzłach obliczeniowych wprowadzonych przez zadanie przygotowania zadania. Przykładowe działania obejmują usuwanie plików lokalnych lub zamykanie usług, które zostały uruchomione w ramach przygotowania zadania.
- common_environment_settings
- list[EnvironmentSetting]
Poszczególne zadania mogą zastąpić ustawienie środowiska określone w tym miejscu, określając tę samą nazwę ustawienia z inną wartością.
- pool_info
- PoolInformation
Wymagane. Pula, w której usługa Batch uruchamia zadania podrzędne zadania.
- on_all_tasks_complete
- str lub OnAllTasksComplete
Akcja, jaką usługa Batch powinna wykonać, gdy wszystkie zadania w zadaniu są w stanie ukończonym. Należy pamiętać, że jeśli zadanie nie zawiera żadnych zadań, wszystkie zadania są uznawane za ukończone. W związku z tym ta opcja jest najczęściej używana z zadaniem Menedżera zadań; Jeśli chcesz używać automatycznego kończenia zadań bez Menedżera zadań, należy początkowo ustawić właściwość onAllTasksComplete na wartość noaction i zaktualizować właściwości zadania, aby ustawić właściwość onAllTasksComplete na zakończenie zadania po zakończeniu dodawania zadań. Wartość domyślna to noaction. Możliwe wartości to: "noAction", "terminateJob"
- on_task_failure
- str lub OnTaskFailure
Akcja, jaką usługa Batch powinna wykonać, gdy dowolne zadanie w zadaniu zakończy się niepowodzeniem. Zadanie jest uznawane za zadanie, które zakończyło się niepowodzeniem, jeśli występuje błądInfo. Właściwość failureInfo jest ustawiana, jeśli zadanie kończy się kodem zakończenia innym niż zero po wyczerpaniu liczby ponownych prób lub jeśli wystąpił błąd podczas uruchamiania zadania, na przykład z powodu błędu pobierania pliku zasobu. Wartość domyślna to noaction. Możliwe wartości to: "noAction", "performExitOptionsJobAction"
- metadata
- list[MetadataItem]
Usługa Batch nie przypisuje żadnego znaczenia do metadanych; jest on przeznaczony wyłącznie do korzystania z kodu użytkownika.
- uses_task_dependencies
- bool
Określa, czy zadania w zadaniu mogą definiować zależności od siebie. Wartością domyślną jest false.
Metody
as_dict |
Zwróć dykt, który może być JSONify przy użyciu pliku json.dump. Użycie zaawansowane może opcjonalnie używać wywołania zwrotnego jako parametru: Klucz to nazwa atrybutu używana w języku Python. Attr_desc to dykt metadanych. Obecnie zawiera ciąg "type" z typem msrest i kluczem zakodowanym za pomocą interfejsu RESTAPI. Wartość jest bieżącą wartością w tym obiekcie. Zwrócony ciąg będzie używany do serializacji klucza. Jeśli zwracany typ jest listą, jest to uznawane za hierarchiczny dykt wyniku. Zobacz trzy przykłady w tym pliku:
Jeśli chcesz serializacji XML, możesz przekazać kwargs is_xml=True. |
deserialize |
Analizowanie ciągu przy użyciu składni restAPI i zwracanie modelu. |
enable_additional_properties_sending | |
from_dict |
Przeanalizuj dykt przy użyciu danego modułu wyodrębniającego klucz, który zwraca model. Domyślnie należy rozważyć wyodrębnianie kluczy (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor i last_rest_key_case_insensitive_extractor) |
is_xml_model | |
serialize |
Zwróć kod JSON, który zostanie wysłany na platformę Azure z tego modelu. Jest to alias as_dict (full_restapi_key_transformer, keep_readonly=False). Jeśli chcesz serializacji XML, możesz przekazać kwargs is_xml=True. |
validate |
Zweryfikuj ten model cyklicznie i zwróć listę błędu ValidationError. |
as_dict
Zwróć dykt, który może być JSONify przy użyciu pliku json.dump.
Użycie zaawansowane może opcjonalnie używać wywołania zwrotnego jako parametru:
Klucz to nazwa atrybutu używana w języku Python. Attr_desc to dykt metadanych. Obecnie zawiera ciąg "type" z typem msrest i kluczem zakodowanym za pomocą interfejsu RESTAPI. Wartość jest bieżącą wartością w tym obiekcie.
Zwrócony ciąg będzie używany do serializacji klucza. Jeśli zwracany typ jest listą, jest to uznawane za hierarchiczny dykt wyniku.
Zobacz trzy przykłady w tym pliku:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
Jeśli chcesz serializacji XML, możesz przekazać kwargs is_xml=True.
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)
Parametry
- key_transformer
- <xref:function>
Funkcja transformatora klucza.
- keep_readonly
Zwraca
Obiekt zgodny z dyktacją JSON
Typ zwracany
deserialize
Analizowanie ciągu przy użyciu składni restAPI i zwracanie modelu.
deserialize(data, content_type=None)
Parametry
- content_type
- str
Domyślnie w formacie JSON ustaw wartość application/xml, jeśli plik XML.
Zwraca
Wystąpienie tego modelu
Wyjątki
enable_additional_properties_sending
enable_additional_properties_sending()
from_dict
Przeanalizuj dykt przy użyciu danego modułu wyodrębniającego klucz, który zwraca model.
Domyślnie należy rozważyć wyodrębnianie kluczy (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor i last_rest_key_case_insensitive_extractor)
from_dict(data, key_extractors=None, content_type=None)
Parametry
- content_type
- str
Domyślnie w formacie JSON ustaw wartość application/xml, jeśli plik XML.
- key_extractors
Zwraca
Wystąpienie tego modelu
Wyjątki
is_xml_model
is_xml_model()
serialize
Zwróć kod JSON, który zostanie wysłany na platformę Azure z tego modelu.
Jest to alias as_dict (full_restapi_key_transformer, keep_readonly=False).
Jeśli chcesz serializacji XML, możesz przekazać kwargs is_xml=True.
serialize(keep_readonly=False, **kwargs)
Parametry
Zwraca
Obiekt zgodny z dyktacją JSON
Typ zwracany
validate
Zweryfikuj ten model cyklicznie i zwróć listę błędu ValidationError.
validate()
Zwraca
Lista błędów walidacji
Typ zwracany
Azure SDK for Python
Opinia
https://aka.ms/ContentUserFeedback.
Dostępne już wkrótce: W 2024 r. będziemy stopniowo wycofywać zgłoszenia z serwisu GitHub jako mechanizm przesyłania opinii na temat zawartości i zastępować go nowym systemem opinii. Aby uzyskać więcej informacji, sprawdź:Prześlij i wyświetl opinię dla