TaskGroup

import type { TaskGroup } from "https://googleapis.deno.dev/v1/batch:v1.ts";

A TaskGroup defines one or more Tasks that all share the same TaskSpec.

interface TaskGroup {

readonly name?: string;

parallelism?: bigint;

permissiveSsh?: boolean;

requireHostsFile?: boolean;

runAsNonRoot?: boolean;

schedulingPolicy?: "SCHEDULING_POLICY_UNSPECIFIED" | "AS_SOON_AS_POSSIBLE" | "IN_ORDER";

taskCount?: bigint;

taskCountPerNode?: bigint;

taskEnvironments?: Environment[];

taskSpec?: TaskSpec;

}

§Properties

readonly name?: string

[src]

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".

parallelism?: bigint

[src]

Max number of tasks that can run in parallel. Default to min(task_count, parallel tasks per job limit). See: Job Limits. Field parallelism must be 1 if the scheduling_policy is IN_ORDER.

permissiveSsh?: boolean

[src]

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

requireHostsFile?: boolean

[src]

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. The host file supports up to 1000 VMs.

runAsNonRoot?: boolean

[src]

Optional. If not set or set to false, Batch uses the root user to execute runnables. If set to true, Batch runs the runnables using a non-root user. Currently, the non-root user Batch used is generated by OS Login. For more information, see About OS Login.

schedulingPolicy?: "SCHEDULING_POLICY_UNSPECIFIED" | "AS_SOON_AS_POSSIBLE" | "IN_ORDER"

[src]

Scheduling policy for Tasks in the TaskGroup. The default value is AS_SOON_AS_POSSIBLE.

taskCount?: bigint

[src]

Number of Tasks in the TaskGroup. Default is 1.

taskCountPerNode?: bigint

[src]

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.

taskEnvironments?: Environment[]

[src]

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).

taskSpec?: TaskSpec

[src]

Required. Tasks in the group share the same task spec.