TaskGroup(mapping=None, *, ignore_unknown_fields=False, **kwargs)A TaskGroup defines one or more Tasks that all share the same TaskSpec.
Attributes | |
|---|---|
| Name | Description |
name |
str
Output only. TaskGroup name. The system generates this field based on parent Job name. For example: "projects/123456/locations/us-west1/jobs/job01/taskGroups/group01". |
task_spec |
google.cloud.batch_v1.types.TaskSpec
Required. Tasks in the group share the same task spec. |
task_count |
int
Number of Tasks in the TaskGroup. Default is 1. |
parallelism |
int
Max number of tasks that can run in parallel. Default to min(task_count, 1000). Field parallelism must be 1 if the scheduling_policy is IN_ORDER. |
scheduling_policy |
google.cloud.batch_v1.types.TaskGroup.SchedulingPolicy
Scheduling policy for Tasks in the TaskGroup. The default value is AS_SOON_AS_POSSIBLE. |
task_environments |
MutableSequence[google.cloud.batch_v1.types.Environment]
An array of environment variable mappings, which are passed to Tasks with matching indices. If task_environments is used then task_count should not be specified in the request (and will be ignored). Task count will be the length of task_environments. Tasks get a BATCH_TASK_INDEX and BATCH_TASK_COUNT environment variable, in addition to any environment variables set in task_environments, specifying the number of Tasks in the Task's parent TaskGroup, and the specific Task's index in the TaskGroup (0 through BATCH_TASK_COUNT - 1). |
task_count_per_node |
int
Max number of tasks that can be run on a VM at the same time. If not specified, the system will decide a value based on available compute resources on a VM and task requirements. |
require_hosts_file |
bool
When true, Batch will populate a file with a list of all VMs assigned to the TaskGroup and set the BATCH_HOSTS_FILE environment variable to the path of that file. Defaults to false. |
permissive_ssh |
bool
When true, Batch will configure SSH to allow passwordless login between VMs running the Batch tasks in the same TaskGroup. |
Classes
SchedulingPolicy
SchedulingPolicy(value)How Tasks in the TaskGroup should be scheduled relative to each other.
Values: SCHEDULING_POLICY_UNSPECIFIED (0): Unspecified. AS_SOON_AS_POSSIBLE (1): Run Tasks as soon as resources are available.
Tasks might be executed in parallel depending on parallelism
and task_count values.
IN_ORDER (2):
Run Tasks sequentially with increased task
index.