Interface TaskGroupOrBuilder (0.53.0)

public interface TaskGroupOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsLabels(String key)

public abstract boolean containsLabels(String key)

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.

map<string, string> labels = 8;

Parameter
Name	Description
`key`	`String`

Returns
Type	Description
`boolean`

getAllocationPolicy()

public abstract AllocationPolicy getAllocationPolicy()

Compute resource allocation for the TaskGroup. If specified, it overrides resources in Job.

.google.cloud.batch.v1alpha.AllocationPolicy allocation_policy = 7;

Returns
Type	Description
`AllocationPolicy`	The allocationPolicy.

getAllocationPolicyOrBuilder()

public abstract AllocationPolicyOrBuilder getAllocationPolicyOrBuilder()

Compute resource allocation for the TaskGroup. If specified, it overrides resources in Job.

.google.cloud.batch.v1alpha.AllocationPolicy allocation_policy = 7;

Returns
Type	Description
`AllocationPolicyOrBuilder`

getLabels() (deprecated)

public abstract Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type	Description
`Map<String,String>`

getLabelsCount()

public abstract int getLabelsCount()

map<string, string> labels = 8;

Returns
Type	Description
`int`

getLabelsMap()

public abstract Map<String,String> getLabelsMap()

map<string, string> labels = 8;

Returns
Type	Description
`Map<String,String>`

getLabelsOrDefault(String key, String defaultValue)

public abstract String getLabelsOrDefault(String key, String defaultValue)

map<string, string> labels = 8;

Parameters
Name	Description
`key`	`String`
`defaultValue`	`String`

Returns
Type	Description
`String`

getLabelsOrThrow(String key)

public abstract String getLabelsOrThrow(String key)

map<string, string> labels = 8;

Parameter
Name	Description
`key`	`String`

Returns
Type	Description
`String`

getName()

public abstract String 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".

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`String`	The name.

getNameBytes()

public abstract ByteString getNameBytes()

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

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`ByteString`	The bytes for name.

getParallelism()

public abstract long 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.

int64 parallelism = 5;

Returns
Type	Description
`long`	The parallelism.

getPermissiveSsh()

public abstract boolean getPermissiveSsh()

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

bool permissive_ssh = 12;

Returns
Type	Description
`boolean`	The permissiveSsh.

getRequireHostsFile()

public abstract boolean 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.

bool require_hosts_file = 11;

Returns
Type	Description
`boolean`	The requireHostsFile.

getRunAsNonRoot()

public abstract boolean 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.

bool run_as_non_root = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`boolean`	The runAsNonRoot.

getSchedulingPolicy()

public abstract TaskGroup.SchedulingPolicy getSchedulingPolicy()

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

.google.cloud.batch.v1alpha.TaskGroup.SchedulingPolicy scheduling_policy = 6;

Returns
Type	Description
`TaskGroup.SchedulingPolicy`	The schedulingPolicy.

getSchedulingPolicyValue()

public abstract int getSchedulingPolicyValue()

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

.google.cloud.batch.v1alpha.TaskGroup.SchedulingPolicy scheduling_policy = 6;

Returns
Type	Description
`int`	The enum numeric value on the wire for schedulingPolicy.

getServiceAccount()

public abstract ServiceAccount getServiceAccount()

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.

.google.cloud.batch.v1alpha.ServiceAccount service_account = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`ServiceAccount`	The serviceAccount.

getServiceAccountOrBuilder()

public abstract ServiceAccountOrBuilder getServiceAccountOrBuilder()

Specify the service account's email field. Ensure scopes include any necessary permissions for tasks, in addition to the default 'cloud-platform' scope.

.google.cloud.batch.v1alpha.ServiceAccount service_account = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`ServiceAccountOrBuilder`

getTaskCount()

public abstract long getTaskCount()

Number of Tasks in the TaskGroup. Default is 1.

int64 task_count = 4;

Returns
Type	Description
`long`	The taskCount.

getTaskCountPerNode()

public abstract long 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.

int64 task_count_per_node = 10;

Returns
Type	Description
`long`	The taskCountPerNode.

getTaskEnvironments(int index)

public abstract Environment getTaskEnvironments(int index)

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