TaskGroupResponse

data class TaskGroupResponse(val name: String, val parallelism: String, val permissiveSsh: Boolean, val requireHostsFile: Boolean, val taskCount: String, val taskCountPerNode: String, val taskEnvironments: List<EnvironmentResponse>, val taskSpec: TaskSpecResponse)

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

Constructors

Link copied to clipboard
constructor(name: String, parallelism: String, permissiveSsh: Boolean, requireHostsFile: Boolean, taskCount: String, taskCountPerNode: String, taskEnvironments: List<EnvironmentResponse>, taskSpec: TaskSpecResponse)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

TaskGroup name. The system generates this field based on parent Job name. For example: "projects/123456/locations/us-west1/jobs/job01/taskGroups/group01".

Link copied to clipboard

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.

Link copied to clipboard

When true, Batch will configure SSH to allow passwordless login between VMs running the Batch tasks in the same TaskGroup.

Link copied to clipboard

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.

Link copied to clipboard

Number of Tasks in the TaskGroup. Default is 1.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

Tasks in the group share the same task spec.