Class TaskGroup (0.46.0)

public final class TaskGroup extends GeneratedMessageV3 implements TaskGroupOrBuilder

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

Protobuf type google.cloud.batch.v1.TaskGroup

Implements

TaskGroupOrBuilder

Static Fields

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

PARALLELISM_FIELD_NUMBER

public static final int PARALLELISM_FIELD_NUMBER
Field Value
Type Description
int

PERMISSIVE_SSH_FIELD_NUMBER

public static final int PERMISSIVE_SSH_FIELD_NUMBER
Field Value
Type Description
int

REQUIRE_HOSTS_FILE_FIELD_NUMBER

public static final int REQUIRE_HOSTS_FILE_FIELD_NUMBER
Field Value
Type Description
int

RUN_AS_NON_ROOT_FIELD_NUMBER

public static final int RUN_AS_NON_ROOT_FIELD_NUMBER
Field Value
Type Description
int

SCHEDULING_POLICY_FIELD_NUMBER

public static final int SCHEDULING_POLICY_FIELD_NUMBER
Field Value
Type Description
int

TASK_COUNT_FIELD_NUMBER

public static final int TASK_COUNT_FIELD_NUMBER
Field Value
Type Description
int

TASK_COUNT_PER_NODE_FIELD_NUMBER

public static final int TASK_COUNT_PER_NODE_FIELD_NUMBER
Field Value
Type Description
int

TASK_ENVIRONMENTS_FIELD_NUMBER

public static final int TASK_ENVIRONMENTS_FIELD_NUMBER
Field Value
Type Description
int

TASK_SPEC_FIELD_NUMBER

public static final int TASK_SPEC_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static TaskGroup getDefaultInstance()
Returns
Type Description
TaskGroup

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static TaskGroup.Builder newBuilder()
Returns
Type Description
TaskGroup.Builder

newBuilder(TaskGroup prototype)

public static TaskGroup.Builder newBuilder(TaskGroup prototype)
Parameter
Name Description
prototype TaskGroup
Returns
Type Description
TaskGroup.Builder

parseDelimitedFrom(InputStream input)

public static TaskGroup parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
TaskGroup
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TaskGroup parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TaskGroup
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static TaskGroup parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
TaskGroup
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static TaskGroup parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TaskGroup
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static TaskGroup parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
TaskGroup
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static TaskGroup parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TaskGroup
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static TaskGroup parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
TaskGroup
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static TaskGroup parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TaskGroup
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static TaskGroup parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
TaskGroup
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TaskGroup parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TaskGroup
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static TaskGroup parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
TaskGroup
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static TaskGroup parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TaskGroup
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<TaskGroup> parser()
Returns
Type Description
Parser<TaskGroup>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public TaskGroup getDefaultInstanceForType()
Returns
Type Description
TaskGroup

getName()

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

getParserForType()

public Parser<TaskGroup> getParserForType()
Returns
Type Description
Parser<TaskGroup>
Overrides

getPermissiveSsh()

public 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 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 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 TaskGroup.SchedulingPolicy getSchedulingPolicy()

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

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

Returns
Type Description
TaskGroup.SchedulingPolicy

The schedulingPolicy.

getSchedulingPolicyValue()

public int getSchedulingPolicyValue()

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

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

Returns
Type Description
int

The enum numeric value on the wire for schedulingPolicy.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getTaskCount()

public long getTaskCount()

Number of Tasks in the TaskGroup. Default is 1.

int64 task_count = 4;

Returns
Type Description
long

The taskCount.

getTaskCountPerNode()

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

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

Parameter
Name Description
index int
Returns
Type Description
Environment

getTaskEnvironmentsCount()

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

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

Returns
Type Description
int

getTaskEnvironmentsList()

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

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

Returns
Type Description
List<Environment>

getTaskEnvironmentsOrBuilder(int index)

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

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

Parameter
Name Description
index int
Returns
Type Description
EnvironmentOrBuilder

getTaskEnvironmentsOrBuilderList()

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

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

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

getTaskSpec()

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

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public TaskGroup.Builder newBuilderForType()
Returns
Type Description
TaskGroup.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected TaskGroup.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
TaskGroup.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public TaskGroup.Builder toBuilder()
Returns
Type Description
TaskGroup.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException