public sealed class TaskGroup : IMessage<TaskGroup>, IEquatable<TaskGroup>, IDeepCloneable<TaskGroup>, IBufferMessage, IMessageReference documentation and code samples for the Batch v1alpha API class TaskGroup.
A TaskGroup defines one or more Tasks that all share the same TaskSpec.
Implements
IMessageTaskGroup, IEquatableTaskGroup, IDeepCloneableTaskGroup, IBufferMessage, IMessageNamespace
Google.Cloud.Batch.V1AlphaAssembly
Google.Cloud.Batch.V1Alpha.dll
Constructors
TaskGroup()
public TaskGroup()TaskGroup(TaskGroup)
public TaskGroup(TaskGroup other)| Parameter | |
|---|---|
| Name | Description |
other |
TaskGroup |
Properties
AllocationPolicy
public AllocationPolicy AllocationPolicy { get; set; }Compute resource allocation for the TaskGroup. If specified, it overrides resources in Job.
| Property Value | |
|---|---|
| Type | Description |
AllocationPolicy |
|
Labels
public MapField<string, string> Labels { get; }Labels for the TaskGroup. Labels could be user provided or system generated. You can assign up to 64 labels. Google Compute Engine label restrictions apply. Label names that start with "goog-" or "google-" are reserved.
| Property Value | |
|---|---|
| Type | Description |
MapFieldstringstring |
|
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, parallel tasks per job limit). See: Job Limits. Field parallelism must be 1 if the scheduling_policy is IN_ORDER.
| Property Value | |
|---|---|
| Type | Description |
long |
|
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 |
bool |
|
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 |
bool |
|
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.
| Property Value | |
|---|---|
| Type | Description |
bool |
|
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 |
TaskGroupTypesSchedulingPolicy |
|
ServiceAccount
public ServiceAccount ServiceAccount { get; set; }Optional. ServiceAccount used by tasks within the task group for the access
to other Cloud resources. This allows tasks to operate with permissions
distinct from the service account for the VM set at AllocationPolicy. Use
this field when tasks require different access rights than those of the VM.
Specify the service account's email field. Ensure scopes
include any necessary permissions for tasks, in addition to the default
'cloud-platform' scope.
| Property Value | |
|---|---|
| Type | Description |
ServiceAccount |
|
TaskCount
public long TaskCount { get; set; }Number of Tasks in the TaskGroup. Default is 1.
| Property Value | |
|---|---|
| Type | Description |
long |
|
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 |
long |
|
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 |
RepeatedFieldEnvironment |
|
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 |
|