public sealed class TaskGroup : IMessage<TaskGroup>, IEquatable<TaskGroup>, IDeepCloneable<TaskGroup>, IBufferMessage, IMessageReference documentation and code samples for the Batch v1 API class TaskGroup.
A TaskGroup contains one or multiple Tasks that share the same Runnable but with different runtime parameters.
Implements
IMessage<TaskGroup>, IEquatable<TaskGroup>, IDeepCloneable<TaskGroup>, IBufferMessage, IMessageNamespace
Google.Cloud.Batch.V1Assembly
Google.Cloud.Batch.V1.dll
Constructors
TaskGroup()
public TaskGroup()TaskGroup(TaskGroup)
public TaskGroup(TaskGroup other)| Parameter | |
|---|---|
| Name | Description |
other | 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 |
String | |
Parallelism
public long Parallelism { get; set; }Max number of tasks that can run in parallel. Default to min(task_count, 1000).
| Property Value | |
|---|---|
| Type | Description |
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 |
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.
| Property Value | |
|---|---|
| Type | Description |
Boolean | |
TaskCount
public long TaskCount { get; set; }Number of Tasks in the TaskGroup. default is 1
| Property Value | |
|---|---|
| Type | Description |
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 |
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).
task_environments supports up to 200 entries.
| Property Value | |
|---|---|
| Type | Description |
RepeatedField<Environment> | |
TaskGroupName
public TaskGroupName TaskGroupName { get; set; }TaskGroupName-typed view over the Name resource name property.
| Property Value | |
|---|---|
| Type | Description |
TaskGroupName | |
TaskSpec
public TaskSpec TaskSpec { get; set; }Required. Tasks in the group share the same task spec.
| Property Value | |
|---|---|
| Type | Description |
TaskSpec | |