Reference documentation and code samples for the Google Cloud Batch V1 Client class TaskGroup.
A TaskGroup contains one or multiple Tasks that share the same Runnable but with different runtime parameters.
Generated from protobuf message google.cloud.batch.v1.TaskGroup
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
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\V1\TaskSpec
Required. Tasks in the group share the same task spec. |
↳ task_count |
int|string
Number of Tasks in the TaskGroup. default is 1 |
↳ parallelism |
int|string
Max number of tasks that can run in parallel. Default to min(task_count, 1000). |
↳ task_environments |
array<Google\Cloud\Batch\V1\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_node |
int|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. |
↳ 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. |
↳ permissive_ssh |
bool
When true, Batch will configure SSH to allow passwordless login between VMs running the Batch tasks in the same TaskGroup. |
getName
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".
Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
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".
Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTaskSpec
Required. Tasks in the group share the same task spec.
Generated from protobuf field .google.cloud.batch.v1.TaskSpec task_spec = 3 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Batch\V1\TaskSpec|null |
|
hasTaskSpec
clearTaskSpec
setTaskSpec
Required. Tasks in the group share the same task spec.
Generated from protobuf field .google.cloud.batch.v1.TaskSpec task_spec = 3 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Batch\V1\TaskSpec
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTaskCount
Number of Tasks in the TaskGroup.
default is 1
Generated from protobuf field int64 task_count = 4;
| Returns | |
|---|---|
| Type | Description |
int|string |
|
setTaskCount
Number of Tasks in the TaskGroup.
default is 1
Generated from protobuf field int64 task_count = 4;
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getParallelism
Max number of tasks that can run in parallel.
Default to min(task_count, 1000).
Generated from protobuf field int64 parallelism = 5;
| Returns | |
|---|---|
| Type | Description |
int|string |
|
setParallelism
Max number of tasks that can run in parallel.
Default to min(task_count, 1000).
Generated from protobuf field int64 parallelism = 5;
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTaskEnvironments
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.
Generated from protobuf field repeated .google.cloud.batch.v1.Environment task_environments = 9;
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setTaskEnvironments
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.
Generated from protobuf field repeated .google.cloud.batch.v1.Environment task_environments = 9;
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\Batch\V1\Environment>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTaskCountPerNode
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.
Generated from protobuf field int64 task_count_per_node = 10;
| Returns | |
|---|---|
| Type | Description |
int|string |
|
setTaskCountPerNode
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.
Generated from protobuf field int64 task_count_per_node = 10;
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRequireHostsFile
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.
Generated from protobuf field bool require_hosts_file = 11;
| Returns | |
|---|---|
| Type | Description |
bool |
|
setRequireHostsFile
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.
Generated from protobuf field bool require_hosts_file = 11;
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPermissiveSsh
When true, Batch will configure SSH to allow passwordless login between VMs running the Batch tasks in the same TaskGroup.
Generated from protobuf field bool permissive_ssh = 12;
| Returns | |
|---|---|
| Type | Description |
bool |
|
setPermissiveSsh
When true, Batch will configure SSH to allow passwordless login between VMs running the Batch tasks in the same TaskGroup.
Generated from protobuf field bool permissive_ssh = 12;
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|