TaskGroupResponse class

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

Constructors

TaskGroupResponse({required Input<String> name, required Input<String> parallelism, required Input<bool> permissiveSsh, required Input<bool> requireHostsFile, required Input<String> schedulingPolicy, required Input<String> taskCount, required Input<String> taskCountPerNode, required Input<List<EnvironmentResponse>> taskEnvironments, required Input<TaskSpecResponse> taskSpec})
Creates a new TaskGroupResponse. name TaskGroup name. The system generates this field based on parent Job name. For example: "projects/123456/locations/us-west1/jobs/job01/taskGroups/group01". parallelism 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 When true, Batch will configure SSH to allow passwordless login between VMs running the Batch tasks in the same TaskGroup. requireHostsFile 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. schedulingPolicy Scheduling policy for Tasks in the TaskGroup. The default value is AS_SOON_AS_POSSIBLE. taskCount Number of Tasks in the TaskGroup. Default is 1. taskCountPerNode 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 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 Tasks in the group share the same task spec.
const
TaskGroupResponse.fromMap(Map<String, dynamic> map)
factory

Properties

hashCode → int
The hash code for this object.
no setterinherited
name → Input<String>
TaskGroup name. The system generates this field based on parent Job name. For example: "projects/123456/locations/us-west1/jobs/job01/taskGroups/group01".
final
parallelism → Input<String>
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.
final
permissiveSsh → Input<bool>
When true, Batch will configure SSH to allow passwordless login between VMs running the Batch tasks in the same TaskGroup.
final
requireHostsFile → Input<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.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
schedulingPolicy → Input<String>
Scheduling policy for Tasks in the TaskGroup. The default value is AS_SOON_AS_POSSIBLE.
final
taskCount → Input<String>
Number of Tasks in the TaskGroup. Default is 1.
final
taskCountPerNode → Input<String>
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.
final
taskEnvironments → Input<List<EnvironmentResponse>>
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).
final
taskSpec → Input<TaskSpecResponse>
Tasks in the group share the same task spec.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited