Class TaskSpec (0.17.25)

TaskSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Spec of a task

Attributes

Name Description
runnables MutableSequence[google.cloud.batch_v1alpha.types.Runnable]
Required. The sequence of one or more runnables (executable scripts, executable containers, and/or barriers) for each task in this task group to run. Each task runs this list of runnables in order. For a task to succeed, all of its script and container runnables each must either exit with a zero status or enable the ignore_exit_status subfield and exit with any status. Background runnables are killed automatically (if they have not already exited) a short time after all foreground runnables have completed. Even though this is likely to result in a non-zero exit status for the background runnable, these automatic kills are not treated as Task failures.
compute_resource google.cloud.batch_v1alpha.types.ComputeResource
ComputeResource requirements.
max_run_duration google.protobuf.duration_pb2.Duration
Maximum duration the task should run before being automatically retried (if enabled) or automatically failed. Format the value of this field as a time limit in seconds followed by s—for example, 3600s for 1 hour. The field accepts any value between 0 and the maximum listed for the Duration field type at https://protobuf.dev/reference/protobuf/google.protobuf/#duration; however, the actual maximum run time for a job will be limited to the maximum run time for a job listed at https://cloud.google.com/batch/quotas#max-job-duration.
max_retry_count int
Maximum number of retries on failures. The default, 0, which means never retry. The valid value range is [0, 10].
lifecycle_policies MutableSequence[google.cloud.batch_v1alpha.types.LifecyclePolicy]
Lifecycle management schema when any task in a task group is failed. Currently we only support one lifecycle policy. When the lifecycle policy condition is met, the action in the policy will execute. If task execution result does not meet with the defined lifecycle policy, we consider it as the default policy. Default policy means if the exit code is 0, exit task. If task ends with non-zero exit code, retry the task with max_retry_count.
environments MutableMapping[str, str]
Deprecated: please use environment(non-plural) instead.
volumes MutableSequence[google.cloud.batch_v1alpha.types.Volume]
Volumes to mount before running Tasks using this TaskSpec.
environment google.cloud.batch_v1alpha.types.Environment
Environment variables to set before running the Task.

Classes

EnvironmentsEntry

EnvironmentsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

Parameters
Name Description
kwargs dict

Keys and values corresponding to the fields of the message.

mapping Union[dict, .Message]

A dictionary or message to be used to determine the values for this message.

ignore_unknown_fields Optional(bool)

If True, do not raise errors for unknown fields. Only applied if mapping is a mapping type or there are keyword parameters.