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.v1alpha.TaskGroup
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
ALLOCATION_POLICY_FIELD_NUMBER
public static final int ALLOCATION_POLICY_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
ENABLE_OSLOGIN_FIELD_NUMBER
public static final int ENABLE_OSLOGIN_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
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 |
|
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()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static TaskGroup.Builder newBuilder()
newBuilder(TaskGroup prototype)
public static TaskGroup.Builder newBuilder(TaskGroup prototype)
| Parameter |
| Name |
Description |
prototype |
TaskGroup
|
public static TaskGroup parseDelimitedFrom(InputStream input)
public static TaskGroup parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static TaskGroup parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static TaskGroup parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static TaskGroup parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static TaskGroup parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static TaskGroup parseFrom(CodedInputStream input)
public static TaskGroup parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static TaskGroup parseFrom(InputStream input)
public static TaskGroup parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static TaskGroup parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static TaskGroup parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<TaskGroup> parser()
Methods
containsLabels(String key)
public 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
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getAllocationPolicy()
public AllocationPolicy getAllocationPolicy()
Compute resource allocation for the TaskGroup.
If specified, it overrides resources in Job.
.google.cloud.batch.v1alpha.AllocationPolicy allocation_policy = 7;
getAllocationPolicyOrBuilder()
public AllocationPolicyOrBuilder getAllocationPolicyOrBuilder()
Compute resource allocation for the TaskGroup.
If specified, it overrides resources in Job.
.google.cloud.batch.v1alpha.AllocationPolicy allocation_policy = 7;
getDefaultInstanceForType()
public TaskGroup getDefaultInstanceForType()
getEnableOslogin()
public boolean getEnableOslogin()
Optional. When true, Batch will use the OS Login generated POSIX account to
exeucute the runnables instead of the default root user.
To control root or non-root privilege for runnable execution, the project \
Admin user needs to configure IAM roles according to
https://cloud.google.com/compute/docs/oslogin/set-up-oslogin#configure_users.
Specifically, if a root execution is needed, the roles/compute.osAdminLogin
should be granted to the Batch job submitter. Otherwise,
roles/compute.osLogin should be granted to the Batch job submitter.
bool enable_oslogin = 13 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
boolean |
The enableOslogin.
|
getLabels() (deprecated)
public Map<String,String> getLabels()
getLabelsCount()
public int getLabelsCount()
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;
| Returns |
| Type |
Description |
int |
|
getLabelsMap()
public Map<String,String> getLabelsMap()
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;
getLabelsOrDefault(String key, String defaultValue)
public String getLabelsOrDefault(String key, String defaultValue)
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;
| Returns |
| Type |
Description |
String |
|
getLabelsOrThrow(String key)
public String getLabelsOrThrow(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 |
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()
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.
bool require_hosts_file = 11;
| Returns |
| Type |
Description |
boolean |
The requireHostsFile.
|
getSchedulingPolicy()
public 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;
getSchedulingPolicyValue()
public 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.
|
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.v1alpha.Environment task_environments = 9;
| Parameter |
| Name |
Description |
index |
int
|
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.v1alpha.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.v1alpha.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).
repeated .google.cloud.batch.v1alpha.Environment task_environments = 9;
| Parameter |
| Name |
Description |
index |
int
|
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.v1alpha.Environment task_environments = 9;
| Returns |
| Type |
Description |
List<? extends com.google.cloud.batch.v1alpha.EnvironmentOrBuilder> |
|
getTaskSpec()
public TaskSpec getTaskSpec()
Required. Tasks in the group share the same task spec.
.google.cloud.batch.v1alpha.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.v1alpha.TaskSpec task_spec = 3 [(.google.api.field_behavior) = REQUIRED];
hasAllocationPolicy()
public boolean hasAllocationPolicy()
Compute resource allocation for the TaskGroup.
If specified, it overrides resources in Job.
.google.cloud.batch.v1alpha.AllocationPolicy allocation_policy = 7;
| Returns |
| Type |
Description |
boolean |
Whether the allocationPolicy field is set.
|
hasTaskSpec()
public boolean hasTaskSpec()
Required. Tasks in the group share the same task spec.
.google.cloud.batch.v1alpha.TaskSpec task_spec = 3 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
boolean |
Whether the taskSpec field is set.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
| Parameter |
| Name |
Description |
number |
int
|
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public TaskGroup.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected TaskGroup.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public TaskGroup.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
