public static final class TaskGroup.Builder extends GeneratedMessageV3.Builder<TaskGroup.Builder> implements TaskGroupOrBuilderA TaskGroup defines one or more Tasks that all share the same TaskSpec.
Protobuf type google.cloud.batch.v1alpha.TaskGroup
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > TaskGroup.BuilderImplements
TaskGroupOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addAllTaskEnvironments(Iterable<? extends Environment> values)
public TaskGroup.Builder addAllTaskEnvironments(Iterable<? extends Environment> values)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 |
values |
Iterable<? extends com.google.cloud.batch.v1alpha.Environment> |
| Returns | |
|---|---|
| Type | Description |
TaskGroup.Builder |
|
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public TaskGroup.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
TaskGroup.Builder |
|
addTaskEnvironments(Environment value)
public TaskGroup.Builder addTaskEnvironments(Environment value)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 |
value |
Environment |
| Returns | |
|---|---|
| Type | Description |
TaskGroup.Builder |
|
addTaskEnvironments(Environment.Builder builderForValue)
public TaskGroup.Builder addTaskEnvironments(Environment.Builder builderForValue)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 |
builderForValue |
Environment.Builder |
| Returns | |
|---|---|
| Type | Description |
TaskGroup.Builder |
|
addTaskEnvironments(int index, Environment value)
public TaskGroup.Builder addTaskEnvironments(int index, Environment value)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;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
Environment |
| Returns | |
|---|---|
| Type | Description |
TaskGroup.Builder |
|
addTaskEnvironments(int index, Environment.Builder builderForValue)
public TaskGroup.Builder addTaskEnvironments(int index, Environment.Builder builderForValue)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;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
Environment.Builder |
| Returns | |
|---|---|
| Type | Description |
TaskGroup.Builder |
|
addTaskEnvironmentsBuilder()
public Environment.Builder addTaskEnvironmentsBuilder()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 |
Environment.Builder |
|
addTaskEnvironmentsBuilder(int index)
public Environment.Builder addTaskEnvironmentsBuilder(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 |
| Returns | |
|---|---|
| Type | Description |
Environment.Builder |
|
build()
public TaskGroup build()| Returns | |
|---|---|
| Type | Description |
TaskGroup |
|
buildPartial()
public TaskGroup buildPartial()| Returns | |
|---|---|
| Type | Description |
TaskGroup |
|
clear()
public TaskGroup.Builder clear()| Returns | |
|---|---|
| Type | Description |
TaskGroup.Builder |
|
clearAllocationPolicy()
public TaskGroup.Builder clearAllocationPolicy()Compute resource allocation for the TaskGroup. If specified, it overrides resources in Job.
.google.cloud.batch.v1alpha.AllocationPolicy allocation_policy = 7;
| Returns | |
|---|---|
| Type | Description |
TaskGroup.Builder |
|
clearField(Descriptors.FieldDescriptor field)
public TaskGroup.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
TaskGroup.Builder |
|
clearLabels()
public TaskGroup.Builder clearLabels()| Returns | |
|---|---|
| Type | Description |
TaskGroup.Builder |
|
clearName()
public TaskGroup.Builder clearName()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 |
TaskGroup.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public TaskGroup.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
TaskGroup.Builder |
|
clearParallelism()
public TaskGroup.Builder clearParallelism()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 |
TaskGroup.Builder |
This builder for chaining. |
clearPermissiveSsh()
public TaskGroup.Builder clearPermissiveSsh()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 |
TaskGroup.Builder |
This builder for chaining. |
clearRequireHostsFile()
public TaskGroup.Builder clearRequireHostsFile()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 |
TaskGroup.Builder |
This builder for chaining. |
clearRunAsNonRoot()
public TaskGroup.Builder clearRunAsNonRoot()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 |
TaskGroup.Builder |
This builder for chaining. |
clearSchedulingPolicy()
public TaskGroup.Builder clearSchedulingPolicy()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.Builder |
This builder for chaining. |
clearServiceAccount()
public TaskGroup.Builder clearServiceAccount() 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 |
TaskGroup.Builder |
|
clearTaskCount()
public TaskGroup.Builder clearTaskCount()Number of Tasks in the TaskGroup. Default is 1.
int64 task_count = 4;
| Returns | |
|---|---|
| Type | Description |
TaskGroup.Builder |
This builder for chaining. |
clearTaskCountPerNode()
public TaskGroup.Builder clearTaskCountPerNode()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 |
TaskGroup.Builder |
This builder for chaining. |
clearTaskEnvironments()
public TaskGroup.Builder clearTaskEnvironments()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 |
TaskGroup.Builder |
|
clearTaskSpec()
public TaskGroup.Builder clearTaskSpec()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 |
TaskGroup.Builder |
|
clone()
public TaskGroup.Builder clone()| Returns | |
|---|---|
| Type | Description |
TaskGroup.Builder |
|
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 |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
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;
| Returns | |
|---|---|
| Type | Description |
AllocationPolicy |
The allocationPolicy. |
getAllocationPolicyBuilder()
public AllocationPolicy.Builder getAllocationPolicyBuilder()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.Builder |
|
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;
| Returns | |
|---|---|
| Type | Description |
AllocationPolicyOrBuilder |
|
getDefaultInstanceForType()
public TaskGroup getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
TaskGroup |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getLabels() (deprecated)
public Map<String,String> getLabels()Use #getLabelsMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
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;
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
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;
| Parameters | |
|---|---|
| Name | Description |
key |
String |
defaultValue |
String |
| 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 |
|
getMutableLabels() (deprecated)
public Map<String,String> getMutableLabels()Use alternate mutation accessors instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
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. |
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.v1alpha.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.v1alpha.TaskGroup.SchedulingPolicy scheduling_policy = 6;
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for schedulingPolicy. |
getServiceAccount()
public 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. |
getServiceAccountBuilder()
public ServiceAccount.Builder getServiceAccountBuilder() 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.Builder |
|
getServiceAccountOrBuilder()
public ServiceAccountOrBuilder getServiceAccountOrBuilder() 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 |
ServiceAccountOrBuilder |
|
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 |
| Returns | |
|---|---|
| Type | Description |
Environment |
|
getTaskEnvironmentsBuilder(int index)
public Environment.Builder getTaskEnvironmentsBuilder(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 |
| Returns | |
|---|---|
| Type | Description |
Environment.Builder |
|
getTaskEnvironmentsBuilderList()
public List<Environment.Builder> getTaskEnvironmentsBuilderList()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<Builder> |
|
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;
| 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.v1alpha.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.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. |
getTaskSpecBuilder()
public TaskSpec.Builder getTaskSpecBuilder()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.Builder |
|
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];
| Returns | |
|---|---|
| Type | Description |
TaskSpecOrBuilder |
|
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. |
hasServiceAccount()
public boolean hasServiceAccount() 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 |
boolean |
Whether the serviceAccount 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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)| Parameter | |
|---|---|
| Name | Description |
number |
int |
| Returns | |
|---|---|
| Type | Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
internalGetMutableMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)| Parameter | |
|---|---|
| Name | Description |
number |
int |
| Returns | |
|---|---|
| Type | Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeAllocationPolicy(AllocationPolicy value)
public TaskGroup.Builder mergeAllocationPolicy(AllocationPolicy value)Compute resource allocation for the TaskGroup. If specified, it overrides resources in Job.
.google.cloud.batch.v1alpha.AllocationPolicy allocation_policy = 7;
| Parameter | |
|---|---|
| Name | Description |
value |
AllocationPolicy |
| Returns | |
|---|---|
| Type | Description |
TaskGroup.Builder |
|
mergeFrom(TaskGroup other)
public TaskGroup.Builder mergeFrom(TaskGroup other)| Parameter | |
|---|---|
| Name | Description |
other |
TaskGroup |
| Returns | |
|---|---|
| Type | Description |
TaskGroup.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public TaskGroup.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
TaskGroup.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public TaskGroup.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
TaskGroup.Builder |
|
mergeServiceAccount(ServiceAccount value)
public TaskGroup.Builder mergeServiceAccount(ServiceAccount value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
ServiceAccount |
| Returns | |
|---|---|
| Type | Description |
TaskGroup.Builder |
|
mergeTaskSpec(TaskSpec value)
public TaskGroup.Builder mergeTaskSpec(TaskSpec value)Required. Tasks in the group share the same task spec.
.google.cloud.batch.v1alpha.TaskSpec task_spec = 3 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
TaskSpec |
| Returns | |
|---|---|
| Type | Description |
TaskGroup.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final TaskGroup.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
TaskGroup.Builder |
|
putAllLabels(Map<String,String> values)
public TaskGroup.Builder putAllLabels(Map<String,String> values)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 |
values |
Map<String,String> |
| Returns | |
|---|---|
| Type | Description |
TaskGroup.Builder |
|
putLabels(String key, String value)
public TaskGroup.Builder putLabels(String key, String value)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;
| Parameters | |
|---|---|
| Name | Description |
key |
String |
value |
String |
| Returns | |
|---|---|
| Type | Description |
TaskGroup.Builder |
|
removeLabels(String key)
public TaskGroup.Builder removeLabels(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 |
TaskGroup.Builder |
|
removeTaskEnvironments(int index)
public TaskGroup.Builder removeTaskEnvironments(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 |
| Returns | |
|---|---|
| Type | Description |
TaskGroup.Builder |
|
setAllocationPolicy(AllocationPolicy value)
public TaskGroup.Builder setAllocationPolicy(AllocationPolicy value)Compute resource allocation for the TaskGroup. If specified, it overrides resources in Job.
.google.cloud.batch.v1alpha.AllocationPolicy allocation_policy = 7;
| Parameter | |
|---|---|
| Name | Description |
value |
AllocationPolicy |
| Returns | |
|---|---|
| Type | Description |
TaskGroup.Builder |
|
setAllocationPolicy(AllocationPolicy.Builder builderForValue)
public TaskGroup.Builder setAllocationPolicy(AllocationPolicy.Builder builderForValue)Compute resource allocation for the TaskGroup. If specified, it overrides resources in Job.
.google.cloud.batch.v1alpha.AllocationPolicy allocation_policy = 7;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
AllocationPolicy.Builder |
| Returns | |
|---|---|
| Type | Description |
TaskGroup.Builder |
|
setField(Descriptors.FieldDescriptor field, Object value)
public TaskGroup.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
TaskGroup.Builder |
|
setName(String value)
public TaskGroup.Builder setName(String value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe name to set. |
| Returns | |
|---|---|
| Type | Description |
TaskGroup.Builder |
This builder for chaining. |
setNameBytes(ByteString value)
public TaskGroup.Builder setNameBytes(ByteString value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for name to set. |
| Returns | |
|---|---|
| Type | Description |
TaskGroup.Builder |
This builder for chaining. |
setParallelism(long value)
public TaskGroup.Builder setParallelism(long value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
longThe parallelism to set. |
| Returns | |
|---|---|
| Type | Description |
TaskGroup.Builder |
This builder for chaining. |
setPermissiveSsh(boolean value)
public TaskGroup.Builder setPermissiveSsh(boolean value)When true, Batch will configure SSH to allow passwordless login between VMs running the Batch tasks in the same TaskGroup.
bool permissive_ssh = 12;
| Parameter | |
|---|---|
| Name | Description |
value |
booleanThe permissiveSsh to set. |
| Returns | |
|---|---|
| Type | Description |
TaskGroup.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public TaskGroup.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
TaskGroup.Builder |
|
setRequireHostsFile(boolean value)
public TaskGroup.Builder setRequireHostsFile(boolean value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
booleanThe requireHostsFile to set. |
| Returns | |
|---|---|
| Type | Description |
TaskGroup.Builder |
This builder for chaining. |
setRunAsNonRoot(boolean value)
public TaskGroup.Builder setRunAsNonRoot(boolean value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
booleanThe runAsNonRoot to set. |
| Returns | |
|---|---|
| Type | Description |
TaskGroup.Builder |
This builder for chaining. |
setSchedulingPolicy(TaskGroup.SchedulingPolicy value)
public TaskGroup.Builder setSchedulingPolicy(TaskGroup.SchedulingPolicy value)Scheduling policy for Tasks in the TaskGroup. The default value is AS_SOON_AS_POSSIBLE.
.google.cloud.batch.v1alpha.TaskGroup.SchedulingPolicy scheduling_policy = 6;
| Parameter | |
|---|---|
| Name | Description |
value |
TaskGroup.SchedulingPolicyThe schedulingPolicy to set. |
| Returns | |
|---|---|
| Type | Description |
TaskGroup.Builder |
This builder for chaining. |
setSchedulingPolicyValue(int value)
public TaskGroup.Builder setSchedulingPolicyValue(int value)Scheduling policy for Tasks in the TaskGroup. The default value is AS_SOON_AS_POSSIBLE.
.google.cloud.batch.v1alpha.TaskGroup.SchedulingPolicy scheduling_policy = 6;
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for schedulingPolicy to set. |
| Returns | |
|---|---|
| Type | Description |
TaskGroup.Builder |
This builder for chaining. |
setServiceAccount(ServiceAccount value)
public TaskGroup.Builder setServiceAccount(ServiceAccount value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
ServiceAccount |
| Returns | |
|---|---|
| Type | Description |
TaskGroup.Builder |
|
setServiceAccount(ServiceAccount.Builder builderForValue)
public TaskGroup.Builder setServiceAccount(ServiceAccount.Builder builderForValue) 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];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
ServiceAccount.Builder |
| Returns | |
|---|---|
| Type | Description |
TaskGroup.Builder |
|
setTaskCount(long value)
public TaskGroup.Builder setTaskCount(long value)Number of Tasks in the TaskGroup. Default is 1.
int64 task_count = 4;
| Parameter | |
|---|---|
| Name | Description |
value |
longThe taskCount to set. |
| Returns | |
|---|---|
| Type | Description |
TaskGroup.Builder |
This builder for chaining. |
setTaskCountPerNode(long value)
public TaskGroup.Builder setTaskCountPerNode(long value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
longThe taskCountPerNode to set. |
| Returns | |
|---|---|
| Type | Description |
TaskGroup.Builder |
This builder for chaining. |
setTaskEnvironments(int index, Environment value)
public TaskGroup.Builder setTaskEnvironments(int index, Environment value)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;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
Environment |
| Returns | |
|---|---|
| Type | Description |
TaskGroup.Builder |
|
setTaskEnvironments(int index, Environment.Builder builderForValue)
public TaskGroup.Builder setTaskEnvironments(int index, Environment.Builder builderForValue)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;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
Environment.Builder |
| Returns | |
|---|---|
| Type | Description |
TaskGroup.Builder |
|
setTaskSpec(TaskSpec value)
public TaskGroup.Builder setTaskSpec(TaskSpec value)Required. Tasks in the group share the same task spec.
.google.cloud.batch.v1alpha.TaskSpec task_spec = 3 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
TaskSpec |
| Returns | |
|---|---|
| Type | Description |
TaskGroup.Builder |
|
setTaskSpec(TaskSpec.Builder builderForValue)
public TaskGroup.Builder setTaskSpec(TaskSpec.Builder builderForValue)Required. Tasks in the group share the same task spec.
.google.cloud.batch.v1alpha.TaskSpec task_spec = 3 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
TaskSpec.Builder |
| Returns | |
|---|---|
| Type | Description |
TaskGroup.Builder |
|
setUnknownFields(UnknownFieldSet unknownFields)
public final TaskGroup.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
TaskGroup.Builder |
|