# Batch v1 API - Class TaskGroup (2.15.0)

<button class="button button-with-icon cloud-select-dropdown__button " aria-haspopup="true">Version latest</button>

- [2.15.0 (latest)](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Batch.V1/latest/Google.Cloud.Batch.V1.TaskGroup)
- [2.14.0](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Batch.V1/2.14.0/Google.Cloud.Batch.V1.TaskGroup)
- [2.13.0](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Batch.V1/2.13.0/Google.Cloud.Batch.V1.TaskGroup)
- [2.12.0](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Batch.V1/2.12.0/Google.Cloud.Batch.V1.TaskGroup)
- [2.11.0](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Batch.V1/2.11.0/Google.Cloud.Batch.V1.TaskGroup)
- [2.10.0](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Batch.V1/2.10.0/Google.Cloud.Batch.V1.TaskGroup)
- [2.9.0](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Batch.V1/2.9.0/Google.Cloud.Batch.V1.TaskGroup)
- [2.8.0](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Batch.V1/2.8.0/Google.Cloud.Batch.V1.TaskGroup)
- [2.7.0](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Batch.V1/2.7.0/Google.Cloud.Batch.V1.TaskGroup)
- [2.6.0](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Batch.V1/2.6.0/Google.Cloud.Batch.V1.TaskGroup)
- [2.5.0](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Batch.V1/2.5.0/Google.Cloud.Batch.V1.TaskGroup)
- [2.4.0](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Batch.V1/2.4.0/Google.Cloud.Batch.V1.TaskGroup)
- [2.3.0](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Batch.V1/2.3.0/Google.Cloud.Batch.V1.TaskGroup)
- [2.2.0](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Batch.V1/2.2.0/Google.Cloud.Batch.V1.TaskGroup)
- [2.1.0](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Batch.V1/2.1.0/Google.Cloud.Batch.V1.TaskGroup)
- [2.0.0](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Batch.V1/2.0.0/Google.Cloud.Batch.V1.TaskGroup)
- [1.3.0](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Batch.V1/1.3.0/Google.Cloud.Batch.V1.TaskGroup)
- [1.2.0](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Batch.V1/1.2.0/Google.Cloud.Batch.V1.TaskGroup)
- [1.1.0](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Batch.V1/1.1.0/Google.Cloud.Batch.V1.TaskGroup)
- [1.0.0](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Batch.V1/1.0.0/Google.Cloud.Batch.V1.TaskGroup)

    public sealed class TaskGroup : IMessage<TaskGroup>, IEquatable<TaskGroup>, IDeepCloneable<TaskGroup>, IBufferMessage, IMessage

Reference documentation and code samples for the Batch v1 API class TaskGroup.

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

## Inheritance

[object](https://learn.microsoft.com/dotnet/api/system.object) \> TaskGroup

## Implements

[IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage-1.html)[TaskGroup](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Batch.V1/latest/Google.Cloud.Batch.V1.TaskGroup), [IEquatable](https://learn.microsoft.com/dotnet/api/system.iequatable-1)[TaskGroup](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Batch.V1/latest/Google.Cloud.Batch.V1.TaskGroup), [IDeepCloneable](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IDeepCloneable-1.html)[TaskGroup](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Batch.V1/latest/Google.Cloud.Batch.V1.TaskGroup), [IBufferMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IBufferMessage.html), [IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage.html)

## Inherited Members

[object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode) [object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype) [object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring)

## Namespace

[Google.Cloud.Batch.V1](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Batch.V1/latest/Google.Cloud.Batch.V1)

## Assembly

Google.Cloud.Batch.V1.dll

## Constructors

### TaskGroup()

    public TaskGroup()

### TaskGroup(TaskGroup)

    public TaskGroup(TaskGroup other)

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `other` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Batch.V1/latest/Google.Cloud.Batch.V1.TaskGroup` |

## Properties

### Name

    public string Name { get; set; }

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

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.string` |   |

### Parallelism

    public long Parallelism { get; set; }

Max number of tasks that can run in parallel.
Default to min(task_count, parallel tasks per job limit).
See: [Job Limits](https://cloud.google.com/batch/quotas#job_limits).
Field parallelism must be 1 if the scheduling_policy is IN_ORDER.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.int64` |   |

### PermissiveSsh

    public bool PermissiveSsh { get; set; }

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

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.boolean` |   |

### RequireHostsFile

    public bool RequireHostsFile { get; set; }

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.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.boolean` |   |

### RunAsNonRoot

    public bool RunAsNonRoot { get; set; }

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](https://cloud.google.com/compute/docs/oslogin).

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.boolean` |   |

### SchedulingPolicy

    public TaskGroup.Types.SchedulingPolicy SchedulingPolicy { get; set; }

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

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Batch.V1/latest/Google.Cloud.Batch.V1.TaskGrouphttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Batch.V1/latest/Google.Cloud.Batch.V1.TaskGroup.Typeshttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Batch.V1/latest/Google.Cloud.Batch.V1.TaskGroup.Types.SchedulingPolicy` |   |

### TaskCount

    public long TaskCount { get; set; }

Number of Tasks in the TaskGroup.
Default is 1.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.int64` |   |

### TaskCountPerNode

    public long TaskCountPerNode { get; set; }

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.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.int64` |   |

### TaskEnvironments

    public RepeatedField<Environment> TaskEnvironments { get; }

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

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.Collections.RepeatedField-1.htmlhttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Batch.V1/latest/Google.Cloud.Batch.V1.Environment` |   |

### TaskGroupName

    public TaskGroupName TaskGroupName { get; set; }

[TaskGroupName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Batch.V1/latest/Google.Cloud.Batch.V1.TaskGroupName)-typed view over the [Name](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Batch.V1/latest/Google.Cloud.Batch.V1.TaskGroup#Google_Cloud_Batch_V1_TaskGroup_Name) resource name property.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Batch.V1/latest/Google.Cloud.Batch.V1.TaskGroupName` |   |

### TaskSpec

    public TaskSpec TaskSpec { get; set; }

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

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Batch.V1/latest/Google.Cloud.Batch.V1.TaskSpec` |   |