public final class TaskGroup extends GeneratedMessageV3 implements TaskGroupOrBuilder
A TaskGroup contains one or multiple Tasks that share the same
Runnable but with different runtime parameters.
Protobuf type google.cloud.batch.v1.TaskGroup
Static Fields
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value
PARALLELISM_FIELD_NUMBER
public static final int PARALLELISM_FIELD_NUMBER
Field Value
PERMISSIVE_SSH_FIELD_NUMBER
public static final int PERMISSIVE_SSH_FIELD_NUMBER
Field Value
REQUIRE_HOSTS_FILE_FIELD_NUMBER
public static final int REQUIRE_HOSTS_FILE_FIELD_NUMBER
Field Value
TASK_COUNT_FIELD_NUMBER
public static final int TASK_COUNT_FIELD_NUMBER
Field Value
TASK_COUNT_PER_NODE_FIELD_NUMBER
public static final int TASK_COUNT_PER_NODE_FIELD_NUMBER
Field Value
TASK_ENVIRONMENTS_FIELD_NUMBER
public static final int TASK_ENVIRONMENTS_FIELD_NUMBER
Field Value
TASK_SPEC_FIELD_NUMBER
public static final int TASK_SPEC_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static TaskGroup getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static TaskGroup.Builder newBuilder()
Returns
newBuilder(TaskGroup prototype)
public static TaskGroup.Builder newBuilder(TaskGroup prototype)
Parameter
Returns
public static TaskGroup parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static TaskGroup parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static TaskGroup parseFrom(byte[] data)
Parameter
| Name |
Description |
| data |
byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static TaskGroup parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static TaskGroup parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static TaskGroup parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static TaskGroup parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static TaskGroup parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static TaskGroup parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static TaskGroup parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static TaskGroup parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static TaskGroup parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<TaskGroup> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getDefaultInstanceForType()
public TaskGroup getDefaultInstanceForType()
Returns
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/default-group".
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| 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/default-group".
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
getParallelism()
public long getParallelism()
Max number of tasks that can run in parallel.
Default to min(task_count, 1000).
int64 parallelism = 5;
| Type |
Description |
| long |
The parallelism.
|
getParserForType()
public Parser<TaskGroup> getParserForType()
Returns
Overrides
getPermissiveSsh()
public boolean getPermissiveSsh()
When true, Batch will configure SSH to allow passwordless login between
VMs for the user running the Batch tasks.
bool permissive_ssh = 12;
| 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.
bool require_hosts_file = 11;
| Type |
Description |
| boolean |
The requireHostsFile.
|
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getTaskCount()
public long getTaskCount()
Number of Tasks in the TaskGroup.
default is 1
int64 task_count = 4;
| Type |
Description |
| long |
The taskCount.
|
getTaskCountPerNode()
public long getTaskCountPerNode()
Max number of tasks that can be run on a node 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;
| 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).
task_environments supports up to 200 entries.
repeated .google.cloud.batch.v1.Environment task_environments = 9;
| Name |
Description |
| index |
int
|
Returns
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).
task_environments supports up to 200 entries.
repeated .google.cloud.batch.v1.Environment task_environments = 9;
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).
task_environments supports up to 200 entries.
repeated .google.cloud.batch.v1.Environment task_environments = 9;
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).
task_environments supports up to 200 entries.
repeated .google.cloud.batch.v1.Environment task_environments = 9;
| Name |
Description |
| index |
int
|
Returns
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).
task_environments supports up to 200 entries.
repeated .google.cloud.batch.v1.Environment task_environments = 9;
| 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];
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];
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
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];
| Type |
Description |
| boolean |
Whether the taskSpec field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public TaskGroup.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected TaskGroup.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public TaskGroup.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
