Interface TaskGroupOrBuilder (0.4.0) 

public interface TaskGroupOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

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

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.

bool require_hosts_file = 11;

Returns
Type Description
boolean

The requireHostsFile.

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). task_environments supports up to 200 entries.

repeated .google.cloud.batch.v1.Environment task_environments = 9;

Parameter
Name Description
index int
Returns
Type Description
Environment

getTaskEnvironmentsCount()

public abstract int getTaskEnvironmentsCount()

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.

repeated .google.cloud.batch.v1.Environment task_environments = 9;

Returns
Type Description
int

getTaskEnvironmentsList()

public abstract List<Environment> getTaskEnvironmentsList()

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.

repeated .google.cloud.batch.v1.Environment task_environments = 9;

Returns
Type Description
List<Environment>

getTaskEnvironmentsOrBuilder(int index)

public abstract EnvironmentOrBuilder getTaskEnvironmentsOrBuilder(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). task_environments supports up to 200 entries.

repeated .google.cloud.batch.v1.Environment task_environments = 9;

Parameter
Name Description
index int
Returns
Type Description
EnvironmentOrBuilder

getTaskEnvironmentsOrBuilderList()

public abstract List<? extends EnvironmentOrBuilder> getTaskEnvironmentsOrBuilderList()

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.

repeated .google.cloud.batch.v1.Environment task_environments = 9;

Returns
Type Description
List<? extends com.google.cloud.batch.v1.EnvironmentOrBuilder>

getTaskSpec()

public abstract TaskSpec getTaskSpec()

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

.google.cloud.batch.v1.TaskSpec task_spec = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
TaskSpec

The taskSpec.

getTaskSpecOrBuilder()

public abstract TaskSpecOrBuilder getTaskSpecOrBuilder()

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

.google.cloud.batch.v1.TaskSpec task_spec = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
TaskSpecOrBuilder

hasTaskSpec()

public abstract boolean hasTaskSpec()

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

.google.cloud.batch.v1.TaskSpec task_spec = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the taskSpec field is set.