JobUpdateParameter Klasa
Zestaw zmian, które mają zostać wprowadzone do zadania.
Aby wysyłać na platformę Azure wszystkie wymagane parametry, należy wypełnić wszystkie wymagane parametry.
- Dziedziczenie
-
JobUpdateParameter
Konstruktor
JobUpdateParameter(*, pool_info, priority: int = None, max_parallel_tasks: int = -1, allow_task_preemption: bool = None, constraints=None, metadata=None, on_all_tasks_complete=None, **kwargs)
Parametry
- priority
- int
Priorytet zadania. Wartości priorytetu mogą wahać się od -1000 do 1000, a wartość -1000 jest najniższym priorytetem i 1000 jest najwyższym priorytetem. Jeśli pominięto, zostanie ustawiona wartość domyślna 0.
- max_parallel_tasks
- int
Maksymalna liczba zadań, które można wykonać równolegle dla zadania. Wartość parametru maxParallelTasks musi być -1 lub większa niż 0, jeśli zostanie 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. Po utworzeniu zadania można zaktualizować element maxParallelTasks zadania przy użyciu interfejsu API zadania aktualizacji. Wartość domyślna: -1 .
- allow_task_preemption
- bool
Czy zadania w tym zadaniu mogą być wywłaszczone przez inne zadania o wysokim priorytcie. Jeśli wartość ma wartość True, inne zadania o wysokim priorytetu przesłane do systemu będą miały pierwszeństwo i będą mogły ponownie kolejkować zadania z tego zadania. Po utworzeniu zadania można zaktualizować element allowTaskPreemption zadania przy użyciu interfejsu API zadania aktualizacji.
- constraints
- JobConstraints
Ograniczenia wykonywania zadania. W przypadku pominięcia ograniczenia zostaną wyczyszczone.
- pool_info
- PoolInformation
Wymagane. Pula, w której usługa Batch uruchamia zadania zadania. Możesz zmienić pulę zadania tylko wtedy, gdy zadanie jest wyłączone. Wywołanie zadania aktualizacji zakończy się niepowodzeniem, jeśli uwzględnisz element poolInfo, a zadanie nie zostanie wyłączone. Jeśli określisz autoPoolSpecification w poolInfo, można zaktualizować tylko właściwość keepAlive autoPoolSpecification, a następnie tylko wtedy, gdy autoPoolSpecification ma wartość poolLifetimeOption zadania (inne właściwości zadania można zaktualizować w normalny sposób).
- metadata
- list[MetadataItem]
Jeśli pominięto, przyjmuje wartość domyślną pustej listy; w efekcie wszystkie istniejące metadane są usuwane.
- on_all_tasks_complete
- str lub OnAllTasksComplete
Akcja, jaką usługa Batch powinna wykonać, gdy wszystkie zadania w zadaniu są w stanie ukończonym. W przypadku pominięcia zachowanie ukończenia jest ustawione na wartość noaction. Jeśli bieżąca wartość jest zakończona, jest to błąd, ponieważ zachowanie ukończenia zadania może nie zostać zmienione z zakończenia do noaction. Nie można zmienić wartości z zakończenia zadania na noaction — oznacza to, że po włączeniu automatycznego zakończenia zadania nie można go ponownie wyłączyć. Jeśli spróbujesz to zrobić, żądanie zakończy się niepowodzeniem, a usługa Batch zwróci kod stanu 400 (nieprawidłowe żądanie) i odpowiedź o błędzie "nieprawidłowa wartość właściwości". Jeśli nie określisz tego elementu w żądaniu PUT, jest on odpowiednikiem przekazywania noaction. Jest to błąd, jeśli bieżąca wartość jest zakończona. Możliwe wartości to: "noAction", "terminateJob"
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 w interfejsie 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 uważane za hierarchiczne 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 wyodrębniającego klucz zwraca model. Domyślnie należy wziąć pod uwagę wyodrębniacze 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ę wartości 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 w interfejsie 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 uważane za hierarchiczne 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 przekształcania klucza.
- keep_readonly
Zwraca
Obiekt zgodny z JSON w formacie 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 wyodrębniającego klucz zwraca model.
Domyślnie należy wziąć pod uwagę wyodrębniacze 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 JSON w formacie JSON
Typ zwracany
validate
Zweryfikuj ten model cyklicznie i zwróć listę wartości ValidationError.
validate()
Zwraca
Lista błędów weryfikacji
Typ zwracany
Azure SDK for Python