Class TaskGroup (0.11.0)

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

A TaskGroup contains one or multiple Tasks that share thesame Runnable but with different runtime parameters.

Attributes

NameDescription
namestr
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_specgoogle.cloud.batch_v1.types.TaskSpec
Required. Tasks in the group share the same task spec.
task_countint
Number of Tasks in the TaskGroup. Default is 1.
parallelismint
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.
task_environmentsMutableSequence[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_environments supports up to 200 entries.
task_count_per_nodeint
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_filebool
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_sshbool
When true, Batch will configure SSH to allow passwordless login between VMs running the Batch tasks in the same TaskGroup.

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-12-04 UTC.