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_v1alpha.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, parallel tasks per job limit). See: `Job Limits |
scheduling_policy |
google.cloud.batch_v1alpha.types.TaskGroup.SchedulingPolicy
Scheduling policy for Tasks in the TaskGroup. The default value is AS_SOON_AS_POSSIBLE. |
allocation_policy |
google.cloud.batch_v1alpha.types.AllocationPolicy
Compute resource allocation for the TaskGroup. If specified, it overrides resources in Job. |
labels |
MutableMapping[str, str]
Labels for the TaskGroup. Labels could be user provided or system generated. You can assign up to 64 labels. `Google Compute Engine label restrictions |
task_environments |
MutableSequence[google.cloud.batch_v1alpha.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. The host file supports up to 1000 VMs. |
permissive_ssh |
bool
When true, Batch will configure SSH to allow passwordless login between VMs running the Batch tasks in the same TaskGroup. |
run_as_non_root |
bool
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 |
service_account |
google.cloud.batch_v1alpha.types.ServiceAccount
Optional. ServiceAccount used by tasks within the task group for the access to other Cloud resources. This allows tasks to operate with permissions distinct from the service account for the VM set at AllocationPolicy. Use this
field when tasks require different access rights than those
of the VM.
Specify the service account's email field. Ensure
scopes include any necessary permissions for tasks, in
addition to the default 'cloud-platform' scope.
|
Classes
LabelsEntry
LabelsEntry(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,
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 |
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.