Package com.google.cloud.batch.v1alpha
Class TaskGroup.Builder
java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<TaskGroup.Builder>
com.google.cloud.batch.v1alpha.TaskGroup.Builder
- All Implemented Interfaces:
TaskGroupOrBuilder,com.google.protobuf.Message.Builder,com.google.protobuf.MessageLite.Builder,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,Cloneable
- Enclosing class:
- TaskGroup
public static final class TaskGroup.Builder
extends com.google.protobuf.GeneratedMessage.Builder<TaskGroup.Builder>
implements TaskGroupOrBuilder
A TaskGroup defines one or more Tasks that all share the same TaskSpec.Protobuf type
google.cloud.batch.v1alpha.TaskGroup-
Method Summary
Modifier and TypeMethodDescriptionaddAllTaskEnvironments(Iterable<? extends Environment> values) An array of environment variable mappings, which are passed to Tasks with matching indices.addTaskEnvironments(int index, Environment value) An array of environment variable mappings, which are passed to Tasks with matching indices.addTaskEnvironments(int index, Environment.Builder builderForValue) An array of environment variable mappings, which are passed to Tasks with matching indices.addTaskEnvironments(Environment value) An array of environment variable mappings, which are passed to Tasks with matching indices.addTaskEnvironments(Environment.Builder builderForValue) An array of environment variable mappings, which are passed to Tasks with matching indices.An array of environment variable mappings, which are passed to Tasks with matching indices.addTaskEnvironmentsBuilder(int index) An array of environment variable mappings, which are passed to Tasks with matching indices.build()clear()Compute resource allocation for the TaskGroup.Output only.Max number of tasks that can run in parallel.When true, Batch will configure SSH to allow passwordless login between VMs running the Batch tasks in the same TaskGroup.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.Optional.Scheduling policy for Tasks in the TaskGroup.Optional.Number of Tasks in the TaskGroup.Max number of tasks that can be run on a VM at the same time.An array of environment variable mappings, which are passed to Tasks with matching indices.Required.booleancontainsLabels(String key) Labels for the TaskGroup.Compute resource allocation for the TaskGroup.Compute resource allocation for the TaskGroup.Compute resource allocation for the TaskGroup.static final com.google.protobuf.Descriptors.Descriptorcom.google.protobuf.Descriptors.DescriptorDeprecated.intLabels for the TaskGroup.Labels for the TaskGroup.getLabelsOrDefault(String key, String defaultValue) Labels for the TaskGroup.getLabelsOrThrow(String key) Labels for the TaskGroup.Deprecated.getName()Output only.com.google.protobuf.ByteStringOutput only.longMax number of tasks that can run in parallel.booleanWhen true, Batch will configure SSH to allow passwordless login between VMs running the Batch tasks in the same TaskGroup.booleanWhen 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.booleanOptional.Scheduling policy for Tasks in the TaskGroup.intScheduling policy for Tasks in the TaskGroup.Optional.Optional.Optional.longNumber of Tasks in the TaskGroup.longMax number of tasks that can be run on a VM at the same time.getTaskEnvironments(int index) An array of environment variable mappings, which are passed to Tasks with matching indices.getTaskEnvironmentsBuilder(int index) An array of environment variable mappings, which are passed to Tasks with matching indices.An array of environment variable mappings, which are passed to Tasks with matching indices.intAn array of environment variable mappings, which are passed to Tasks with matching indices.An array of environment variable mappings, which are passed to Tasks with matching indices.getTaskEnvironmentsOrBuilder(int index) An array of environment variable mappings, which are passed to Tasks with matching indices.List<? extends EnvironmentOrBuilder>An array of environment variable mappings, which are passed to Tasks with matching indices.Required.Required.Required.booleanCompute resource allocation for the TaskGroup.booleanOptional.booleanRequired.protected com.google.protobuf.GeneratedMessage.FieldAccessorTableprotected com.google.protobuf.MapFieldReflectionAccessorinternalGetMapFieldReflection(int number) protected com.google.protobuf.MapFieldReflectionAccessorinternalGetMutableMapFieldReflection(int number) final booleanCompute resource allocation for the TaskGroup.mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) mergeFrom(com.google.protobuf.Message other) Optional.mergeTaskSpec(TaskSpec value) Required.putAllLabels(Map<String, String> values) Labels for the TaskGroup.Labels for the TaskGroup.removeLabels(String key) Labels for the TaskGroup.removeTaskEnvironments(int index) An array of environment variable mappings, which are passed to Tasks with matching indices.Compute resource allocation for the TaskGroup.setAllocationPolicy(AllocationPolicy.Builder builderForValue) Compute resource allocation for the TaskGroup.Output only.setNameBytes(com.google.protobuf.ByteString value) Output only.setParallelism(long value) Max number of tasks that can run in parallel.setPermissiveSsh(boolean value) When true, Batch will configure SSH to allow passwordless login between VMs running the Batch tasks in the same TaskGroup.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.setRunAsNonRoot(boolean value) Optional.Scheduling policy for Tasks in the TaskGroup.setSchedulingPolicyValue(int value) Scheduling policy for Tasks in the TaskGroup.setServiceAccount(ServiceAccount value) Optional.setServiceAccount(ServiceAccount.Builder builderForValue) Optional.setTaskCount(long value) Number of Tasks in the TaskGroup.setTaskCountPerNode(long value) Max number of tasks that can be run on a VM at the same time.setTaskEnvironments(int index, Environment value) An array of environment variable mappings, which are passed to Tasks with matching indices.setTaskEnvironments(int index, Environment.Builder builderForValue) An array of environment variable mappings, which are passed to Tasks with matching indices.setTaskSpec(TaskSpec value) Required.setTaskSpec(TaskSpec.Builder builderForValue) Required.Methods inherited from class com.google.protobuf.GeneratedMessage.Builder
addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageExceptionMethods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFromMethods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFromMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetMapFieldReflection
protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number) - Overrides:
internalGetMapFieldReflectionin classcom.google.protobuf.GeneratedMessage.Builder<TaskGroup.Builder>
-
internalGetMutableMapFieldReflection
protected com.google.protobuf.MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number) - Overrides:
internalGetMutableMapFieldReflectionin classcom.google.protobuf.GeneratedMessage.Builder<TaskGroup.Builder>
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessage.Builder<TaskGroup.Builder>
-
clear
- Specified by:
clearin interfacecom.google.protobuf.Message.Builder- Specified by:
clearin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
clearin classcom.google.protobuf.GeneratedMessage.Builder<TaskGroup.Builder>
-
getDescriptorForType
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.Message.Builder- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.MessageOrBuilder- Overrides:
getDescriptorForTypein classcom.google.protobuf.GeneratedMessage.Builder<TaskGroup.Builder>
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-
build
- Specified by:
buildin interfacecom.google.protobuf.Message.Builder- Specified by:
buildin interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
- Specified by:
buildPartialin interfacecom.google.protobuf.Message.Builder- Specified by:
buildPartialin interfacecom.google.protobuf.MessageLite.Builder
-
mergeFrom
- Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<TaskGroup.Builder>
-
mergeFrom
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessage.Builder<TaskGroup.Builder>
-
mergeFrom
public TaskGroup.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Specified by:
mergeFromin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<TaskGroup.Builder>- Throws:
IOException
-
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];- Specified by:
getNamein interfaceTaskGroupOrBuilder- Returns:
- The name.
-
getNameBytes
public com.google.protobuf.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];- Specified by:
getNameBytesin interfaceTaskGroupOrBuilder- Returns:
- The bytes for name.
-
setName
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];- Parameters:
value- The name to set.- Returns:
- This builder for chaining.
-
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:
- This builder for chaining.
-
setNameBytes
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];- Parameters:
value- The bytes for name to set.- Returns:
- This builder for chaining.
-
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];- Specified by:
hasTaskSpecin interfaceTaskGroupOrBuilder- Returns:
- Whether the taskSpec field is set.
-
getTaskSpec
Required. Tasks in the group share the same task spec.
.google.cloud.batch.v1alpha.TaskSpec task_spec = 3 [(.google.api.field_behavior) = REQUIRED];- Specified by:
getTaskSpecin interfaceTaskGroupOrBuilder- Returns:
- The taskSpec.
-
setTaskSpec
Required. Tasks in the group share the same task spec.
.google.cloud.batch.v1alpha.TaskSpec task_spec = 3 [(.google.api.field_behavior) = REQUIRED]; -
setTaskSpec
Required. Tasks in the group share the same task spec.
.google.cloud.batch.v1alpha.TaskSpec task_spec = 3 [(.google.api.field_behavior) = REQUIRED]; -
mergeTaskSpec
Required. Tasks in the group share the same task spec.
.google.cloud.batch.v1alpha.TaskSpec task_spec = 3 [(.google.api.field_behavior) = REQUIRED]; -
clearTaskSpec
Required. Tasks in the group share the same task spec.
.google.cloud.batch.v1alpha.TaskSpec task_spec = 3 [(.google.api.field_behavior) = REQUIRED]; -
getTaskSpecBuilder
Required. Tasks in the group share the same task spec.
.google.cloud.batch.v1alpha.TaskSpec task_spec = 3 [(.google.api.field_behavior) = REQUIRED]; -
getTaskSpecOrBuilder
Required. Tasks in the group share the same task spec.
.google.cloud.batch.v1alpha.TaskSpec task_spec = 3 [(.google.api.field_behavior) = REQUIRED];- Specified by:
getTaskSpecOrBuilderin interfaceTaskGroupOrBuilder
-
getTaskCount
public long getTaskCount()Number of Tasks in the TaskGroup. Default is 1.
int64 task_count = 4;- Specified by:
getTaskCountin interfaceTaskGroupOrBuilder- Returns:
- The taskCount.
-
setTaskCount
Number of Tasks in the TaskGroup. Default is 1.
int64 task_count = 4;- Parameters:
value- The taskCount to set.- Returns:
- This builder for chaining.
-
clearTaskCount
Number of Tasks in the TaskGroup. Default is 1.
int64 task_count = 4;- Returns:
- This builder for chaining.
-
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](https://cloud.google.com/batch/quotas#job_limits). Field parallelism must be 1 if the scheduling_policy is IN_ORDER.
int64 parallelism = 5;- Specified by:
getParallelismin interfaceTaskGroupOrBuilder- Returns:
- The parallelism.
-
setParallelism
Max number of tasks that can run in parallel. Default to min(task_count, parallel tasks per job limit). See: [Job Limits](https://cloud.google.com/batch/quotas#job_limits). Field parallelism must be 1 if the scheduling_policy is IN_ORDER.
int64 parallelism = 5;- Parameters:
value- The parallelism to set.- Returns:
- This builder for chaining.
-
clearParallelism
Max number of tasks that can run in parallel. Default to min(task_count, parallel tasks per job limit). See: [Job Limits](https://cloud.google.com/batch/quotas#job_limits). Field parallelism must be 1 if the scheduling_policy is IN_ORDER.
int64 parallelism = 5;- Returns:
- This builder for chaining.
-
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;- Specified by:
getSchedulingPolicyValuein interfaceTaskGroupOrBuilder- Returns:
- The enum numeric value on the wire for schedulingPolicy.
-
setSchedulingPolicyValue
Scheduling policy for Tasks in the TaskGroup. The default value is AS_SOON_AS_POSSIBLE.
.google.cloud.batch.v1alpha.TaskGroup.SchedulingPolicy scheduling_policy = 6;- Parameters:
value- The enum numeric value on the wire for schedulingPolicy to set.- Returns:
- This builder for chaining.
-
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;- Specified by:
getSchedulingPolicyin interfaceTaskGroupOrBuilder- Returns:
- The schedulingPolicy.
-
setSchedulingPolicy
Scheduling policy for Tasks in the TaskGroup. The default value is AS_SOON_AS_POSSIBLE.
.google.cloud.batch.v1alpha.TaskGroup.SchedulingPolicy scheduling_policy = 6;- Parameters:
value- The schedulingPolicy to set.- Returns:
- This builder for chaining.
-
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:
- This builder for chaining.
-
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;- Specified by:
hasAllocationPolicyin interfaceTaskGroupOrBuilder- Returns:
- Whether the allocationPolicy field is set.
-
getAllocationPolicy
Compute resource allocation for the TaskGroup. If specified, it overrides resources in Job.
.google.cloud.batch.v1alpha.AllocationPolicy allocation_policy = 7;- Specified by:
getAllocationPolicyin interfaceTaskGroupOrBuilder- Returns:
- The allocationPolicy.
-
setAllocationPolicy
Compute resource allocation for the TaskGroup. If specified, it overrides resources in Job.
.google.cloud.batch.v1alpha.AllocationPolicy allocation_policy = 7; -
setAllocationPolicy
Compute resource allocation for the TaskGroup. If specified, it overrides resources in Job.
.google.cloud.batch.v1alpha.AllocationPolicy allocation_policy = 7; -
mergeAllocationPolicy
Compute resource allocation for the TaskGroup. If specified, it overrides resources in Job.
.google.cloud.batch.v1alpha.AllocationPolicy allocation_policy = 7; -
clearAllocationPolicy
Compute resource allocation for the TaskGroup. If specified, it overrides resources in Job.
.google.cloud.batch.v1alpha.AllocationPolicy allocation_policy = 7; -
getAllocationPolicyBuilder
Compute resource allocation for the TaskGroup. If specified, it overrides resources in Job.
.google.cloud.batch.v1alpha.AllocationPolicy allocation_policy = 7; -
getAllocationPolicyOrBuilder
Compute resource allocation for the TaskGroup. If specified, it overrides resources in Job.
.google.cloud.batch.v1alpha.AllocationPolicy allocation_policy = 7;- Specified by:
getAllocationPolicyOrBuilderin interfaceTaskGroupOrBuilder
-
getLabelsCount
public int getLabelsCount()Description copied from interface:TaskGroupOrBuilderLabels for the TaskGroup. Labels could be user provided or system generated. You can assign up to 64 labels. [Google Compute Engine label restrictions](https://cloud.google.com/compute/docs/labeling-resources#restrictions) apply. Label names that start with "goog-" or "google-" are reserved.
map<string, string> labels = 8;- Specified by:
getLabelsCountin interfaceTaskGroupOrBuilder
-
containsLabels
Labels for the TaskGroup. Labels could be user provided or system generated. You can assign up to 64 labels. [Google Compute Engine label restrictions](https://cloud.google.com/compute/docs/labeling-resources#restrictions) apply. Label names that start with "goog-" or "google-" are reserved.
map<string, string> labels = 8;- Specified by:
containsLabelsin interfaceTaskGroupOrBuilder
-
getLabels
Deprecated.UsegetLabelsMap()instead.- Specified by:
getLabelsin interfaceTaskGroupOrBuilder
-
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](https://cloud.google.com/compute/docs/labeling-resources#restrictions) apply. Label names that start with "goog-" or "google-" are reserved.
map<string, string> labels = 8;- Specified by:
getLabelsMapin interfaceTaskGroupOrBuilder
-
getLabelsOrDefault
Labels for the TaskGroup. Labels could be user provided or system generated. You can assign up to 64 labels. [Google Compute Engine label restrictions](https://cloud.google.com/compute/docs/labeling-resources#restrictions) apply. Label names that start with "goog-" or "google-" are reserved.
map<string, string> labels = 8;- Specified by:
getLabelsOrDefaultin interfaceTaskGroupOrBuilder
-
getLabelsOrThrow
Labels for the TaskGroup. Labels could be user provided or system generated. You can assign up to 64 labels. [Google Compute Engine label restrictions](https://cloud.google.com/compute/docs/labeling-resources#restrictions) apply. Label names that start with "goog-" or "google-" are reserved.
map<string, string> labels = 8;- Specified by:
getLabelsOrThrowin interfaceTaskGroupOrBuilder
-
clearLabels
-
removeLabels
Labels for the TaskGroup. Labels could be user provided or system generated. You can assign up to 64 labels. [Google Compute Engine label restrictions](https://cloud.google.com/compute/docs/labeling-resources#restrictions) apply. Label names that start with "goog-" or "google-" are reserved.
map<string, string> labels = 8; -
getMutableLabels
Deprecated.Use alternate mutation accessors instead. -
putLabels
Labels for the TaskGroup. Labels could be user provided or system generated. You can assign up to 64 labels. [Google Compute Engine label restrictions](https://cloud.google.com/compute/docs/labeling-resources#restrictions) apply. Label names that start with "goog-" or "google-" are reserved.
map<string, string> labels = 8; -
putAllLabels
Labels for the TaskGroup. Labels could be user provided or system generated. You can assign up to 64 labels. [Google Compute Engine label restrictions](https://cloud.google.com/compute/docs/labeling-resources#restrictions) apply. Label names that start with "goog-" or "google-" are reserved.
map<string, string> labels = 8; -
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;- Specified by:
getTaskEnvironmentsListin interfaceTaskGroupOrBuilder
-
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;- Specified by:
getTaskEnvironmentsCountin interfaceTaskGroupOrBuilder
-
getTaskEnvironments
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;- Specified by:
getTaskEnvironmentsin interfaceTaskGroupOrBuilder
-
setTaskEnvironments
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; -
setTaskEnvironments
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; -
addTaskEnvironments
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; -
addTaskEnvironments
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; -
addTaskEnvironments
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; -
addTaskEnvironments
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; -
addAllTaskEnvironments
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; -
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; -
removeTaskEnvironments
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; -
getTaskEnvironmentsBuilder
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
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;- Specified by:
getTaskEnvironmentsOrBuilderin interfaceTaskGroupOrBuilder
-
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;- Specified by:
getTaskEnvironmentsOrBuilderListin interfaceTaskGroupOrBuilder
-
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; -
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; -
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; -
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;- Specified by:
getTaskCountPerNodein interfaceTaskGroupOrBuilder- Returns:
- The taskCountPerNode.
-
setTaskCountPerNode
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;- Parameters:
value- The taskCountPerNode to set.- Returns:
- This builder for chaining.
-
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:
- This builder for chaining.
-
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;- Specified by:
getRequireHostsFilein interfaceTaskGroupOrBuilder- Returns:
- The requireHostsFile.
-
setRequireHostsFile
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;- Parameters:
value- The requireHostsFile to set.- Returns:
- This builder for chaining.
-
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:
- This builder for chaining.
-
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;- Specified by:
getPermissiveSshin interfaceTaskGroupOrBuilder- Returns:
- The permissiveSsh.
-
setPermissiveSsh
When true, Batch will configure SSH to allow passwordless login between VMs running the Batch tasks in the same TaskGroup.
bool permissive_ssh = 12;- Parameters:
value- The permissiveSsh to set.- Returns:
- This builder for chaining.
-
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:
- This builder for chaining.
-
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](https://cloud.google.com/compute/docs/oslogin).
bool run_as_non_root = 14 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getRunAsNonRootin interfaceTaskGroupOrBuilder- Returns:
- The runAsNonRoot.
-
setRunAsNonRoot
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](https://cloud.google.com/compute/docs/oslogin).
bool run_as_non_root = 14 [(.google.api.field_behavior) = OPTIONAL];- Parameters:
value- The runAsNonRoot to set.- Returns:
- This builder for chaining.
-
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](https://cloud.google.com/compute/docs/oslogin).
bool run_as_non_root = 14 [(.google.api.field_behavior) = OPTIONAL];- Returns:
- This builder for chaining.
-
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];- Specified by:
hasServiceAccountin interfaceTaskGroupOrBuilder- Returns:
- Whether the serviceAccount field is set.
-
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];- Specified by:
getServiceAccountin interfaceTaskGroupOrBuilder- Returns:
- The serviceAccount.
-
setServiceAccount
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]; -
setServiceAccount
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]; -
mergeServiceAccount
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]; -
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]; -
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]; -
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];- Specified by:
getServiceAccountOrBuilderin interfaceTaskGroupOrBuilder
-