Reference documentation and code samples for the Google Cloud Batch V1 Client class TaskGroup.
A TaskGroup defines one or more Tasks that all share the same TaskSpec.
Generated from protobuf message google.cloud.batch.v1.TaskGroup
Namespace
Google \ Cloud \ Batch \ V1Methods
__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 |
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, parallel tasks per job limit). See: Job Limits. Field parallelism must be 1 if the scheduling_policy is IN_ORDER. |
↳ scheduling_policy |
int
Scheduling policy for Tasks in the TaskGroup. The default value is AS_SOON_AS_POSSIBLE. |
↳ task_environments |
array<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|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. 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. |
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".
| 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".
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTaskSpec
Required. Tasks in the group share the same task spec.
| Returns | |
|---|---|
| Type | Description |
TaskSpec|null |
|
hasTaskSpec
clearTaskSpec
setTaskSpec
Required. Tasks in the group share the same task spec.
| Parameter | |
|---|---|
| Name | Description |
var |
TaskSpec
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTaskCount
Number of Tasks in the TaskGroup.
Default is 1.
| Returns | |
|---|---|
| Type | Description |
int|string |
|
setTaskCount
Number of Tasks in the TaskGroup.
Default is 1.
| 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, parallel tasks per job limit). See: Job Limits. Field parallelism must be 1 if the scheduling_policy is IN_ORDER.
| Returns | |
|---|---|
| Type | Description |
int|string |
|
setParallelism
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.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSchedulingPolicy
Scheduling policy for Tasks in the TaskGroup.
The default value is AS_SOON_AS_POSSIBLE.
| Returns | |
|---|---|
| Type | Description |
int |
|
setSchedulingPolicy
Scheduling policy for Tasks in the TaskGroup.
The default value is AS_SOON_AS_POSSIBLE.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| 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).
| 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).
| Parameter | |
|---|---|
| Name | Description |
var |
array<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.
| 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.
| 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. The host file supports up to 1000 VMs.
| 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. The host file supports up to 1000 VMs.
| 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.
| 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.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRunAsNonRoot
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.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setRunAsNonRoot
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.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|