- 0.51.0 (latest)
- 0.49.0
- 0.48.0
- 0.47.0
- 0.46.0
- 0.45.0
- 0.44.0
- 0.43.0
- 0.42.0
- 0.41.0
- 0.40.0
- 0.39.0
- 0.37.0
- 0.36.0
- 0.35.0
- 0.34.0
- 0.33.0
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.24.0
- 0.23.0
- 0.22.0
- 0.21.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.14.0
- 0.13.0
- 0.12.0
- 0.11.0
- 0.10.0
- 0.9.0
- 0.8.0
- 0.7.0
- 0.6.0
- 0.5.0
- 0.4.0
- 0.3.2
- 0.2.2
- 0.1.1
public interface TaskGroupOrBuilder extends MessageOrBuilder
Implements
MessageOrBuilderMethods
getName()
public abstract 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/default-group".
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
Type | Description |
String | The name. |
getNameBytes()
public abstract ByteString getNameBytes()
Output only. TaskGroup name. The system generates this field based on parent Job name. For example: "projects/123456/locations/us-west1/jobs/job01/taskGroups/default-group".
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
Type | Description |
ByteString | The bytes for name. |
getParallelism()
public abstract long getParallelism()
Max number of tasks that can run in parallel. Default to min(task_count, 1000).
int64 parallelism = 5;
Type | Description |
long | The parallelism. |
getPermissiveSsh()
public abstract boolean getPermissiveSsh()
When true, Batch will configure SSH to allow passwordless login between VMs for the user running the Batch tasks.
bool permissive_ssh = 12;
Type | Description |
boolean | The permissiveSsh. |
getRequireHostsFile()
public abstract boolean getRequireHostsFile()
When true, Batch will populate a file with a list of all VMs assigned to the TaskGroup and set the BATCH_HOSTS_FILE environment variable to the path of that file. Defaults to false.
bool require_hosts_file = 11;
Type | Description |
boolean | The requireHostsFile. |
getTaskCount()
public abstract long getTaskCount()
Number of Tasks in the TaskGroup. default is 1
int64 task_count = 4;
Type | Description |
long | The taskCount. |
getTaskCountPerNode()
public abstract long getTaskCountPerNode()
Max number of tasks that can be run on a node at the same time. If not specified, the system will decide a value based on available compute resources on a VM and task requirements.
int64 task_count_per_node = 10;
Type | Description |
long | The taskCountPerNode. |
getTaskEnvironments(int index)
public abstract Environment getTaskEnvironments(int index)
An array of environment variable mappings, which are passed to Tasks with matching indices. If task_environments is used then task_count should not be specified in the request (and will be ignored). Task count will be the length of task_environments. Tasks get a BATCH_TASK_INDEX and BATCH_TASK_COUNT environment variable, in addition to any environment variables set in task_environments, specifying the number of Tasks in the Task's parent TaskGroup, and the specific Task's index in the TaskGroup (0 through BATCH_TASK_COUNT - 1). task_environments supports up to 200 entries.
repeated .google.cloud.batch.v1.Environment task_environments = 9;
Name | Description |
index | int |
Type | Description |
Environment |
getTaskEnvironmentsCount()
public abstract int getTaskEnvironmentsCount()
An array of environment variable mappings, which are passed to Tasks with matching indices. If task_environments is used then task_count should not be specified in the request (and will be ignored). Task count will be the length of task_environments. Tasks get a BATCH_TASK_INDEX and BATCH_TASK_COUNT environment variable, in addition to any environment variables set in task_environments, specifying the number of Tasks in the Task's parent TaskGroup, and the specific Task's index in the TaskGroup (0 through BATCH_TASK_COUNT - 1). task_environments supports up to 200 entries.
repeated .google.cloud.batch.v1.Environment task_environments = 9;
Type | Description |
int |
getTaskEnvironmentsList()
public abstract List<Environment> getTaskEnvironmentsList()
An array of environment variable mappings, which are passed to Tasks with matching indices. If task_environments is used then task_count should not be specified in the request (and will be ignored). Task count will be the length of task_environments. Tasks get a BATCH_TASK_INDEX and BATCH_TASK_COUNT environment variable, in addition to any environment variables set in task_environments, specifying the number of Tasks in the Task's parent TaskGroup, and the specific Task's index in the TaskGroup (0 through BATCH_TASK_COUNT - 1). task_environments supports up to 200 entries.
repeated .google.cloud.batch.v1.Environment task_environments = 9;
Type | Description |
List<Environment> |
getTaskEnvironmentsOrBuilder(int index)
public abstract EnvironmentOrBuilder getTaskEnvironmentsOrBuilder(int index)
An array of environment variable mappings, which are passed to Tasks with matching indices. If task_environments is used then task_count should not be specified in the request (and will be ignored). Task count will be the length of task_environments. Tasks get a BATCH_TASK_INDEX and BATCH_TASK_COUNT environment variable, in addition to any environment variables set in task_environments, specifying the number of Tasks in the Task's parent TaskGroup, and the specific Task's index in the TaskGroup (0 through BATCH_TASK_COUNT - 1). task_environments supports up to 200 entries.
repeated .google.cloud.batch.v1.Environment task_environments = 9;
Name | Description |
index | int |
Type | Description |
EnvironmentOrBuilder |
getTaskEnvironmentsOrBuilderList()
public abstract List<? extends EnvironmentOrBuilder> getTaskEnvironmentsOrBuilderList()
An array of environment variable mappings, which are passed to Tasks with matching indices. If task_environments is used then task_count should not be specified in the request (and will be ignored). Task count will be the length of task_environments. Tasks get a BATCH_TASK_INDEX and BATCH_TASK_COUNT environment variable, in addition to any environment variables set in task_environments, specifying the number of Tasks in the Task's parent TaskGroup, and the specific Task's index in the TaskGroup (0 through BATCH_TASK_COUNT - 1). task_environments supports up to 200 entries.
repeated .google.cloud.batch.v1.Environment task_environments = 9;
Type | Description |
List<? extends com.google.cloud.batch.v1.EnvironmentOrBuilder> |
getTaskSpec()
public abstract TaskSpec getTaskSpec()
Required. Tasks in the group share the same task spec.
.google.cloud.batch.v1.TaskSpec task_spec = 3 [(.google.api.field_behavior) = REQUIRED];
Type | Description |
TaskSpec | The taskSpec. |
getTaskSpecOrBuilder()
public abstract TaskSpecOrBuilder getTaskSpecOrBuilder()
Required. Tasks in the group share the same task spec.
.google.cloud.batch.v1.TaskSpec task_spec = 3 [(.google.api.field_behavior) = REQUIRED];
Type | Description |
TaskSpecOrBuilder |
hasTaskSpec()
public abstract boolean hasTaskSpec()
Required. Tasks in the group share the same task spec.
.google.cloud.batch.v1.TaskSpec task_spec = 3 [(.google.api.field_behavior) = REQUIRED];
Type | Description |
boolean | Whether the taskSpec field is set. |