Class TaskGroup

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

Inheritance
object
TaskGroup
Implements
Inherited Members
Namespace: Google.Apis.Batch.v1.Data
Assembly: Google.Apis.Batch.v1.dll
Syntax
public class TaskGroup : IDirectResponseSchema

Properties

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

Name

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

Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
Type Description
string

Parallelism

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.

Declaration
[JsonProperty("parallelism")]
public virtual long? Parallelism { get; set; }
Property Value
Type Description
long?

PermissiveSsh

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

Declaration
[JsonProperty("permissiveSsh")]
public virtual bool? PermissiveSsh { get; set; }
Property Value
Type Description
bool?

RequireHostsFile

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.

Declaration
[JsonProperty("requireHostsFile")]
public virtual bool? RequireHostsFile { get; set; }
Property Value
Type Description
bool?

RunAsNonRoot

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.

Declaration
[JsonProperty("runAsNonRoot")]
public virtual bool? RunAsNonRoot { get; set; }
Property Value
Type Description
bool?

SchedulingPolicy

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

Declaration
[JsonProperty("schedulingPolicy")]
public virtual string SchedulingPolicy { get; set; }
Property Value
Type Description
string

TaskCount

Number of Tasks in the TaskGroup. Default is 1.

Declaration
[JsonProperty("taskCount")]
public virtual long? TaskCount { get; set; }
Property Value
Type Description
long?

TaskCountPerNode

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.

Declaration
[JsonProperty("taskCountPerNode")]
public virtual long? TaskCountPerNode { get; set; }
Property Value
Type Description
long?

TaskEnvironments

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

Declaration
[JsonProperty("taskEnvironments")]
public virtual IList<Environment> TaskEnvironments { get; set; }
Property Value
Type Description
IList<Environment>

TaskSpec

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

Declaration
[JsonProperty("taskSpec")]
public virtual TaskSpec TaskSpec { get; set; }
Property Value
Type Description
TaskSpec

Implements