/*
* Copyright 2020 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/cloud/batch/v1alpha/job.proto
package com.google.cloud.batch.v1alpha;
public interface TaskGroupOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.batch.v1alpha.TaskGroup)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* 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];
*
* @return The name.
*/
java.lang.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];
*
* @return The bytes for name.
*/
com.google.protobuf.ByteString getNameBytes();
/**
*
*
*
* Required. Tasks in the group share the same task spec.
*
*
*
* .google.cloud.batch.v1alpha.TaskSpec task_spec = 3 [(.google.api.field_behavior) = REQUIRED];
*
*
* @return Whether the taskSpec field is set.
*/
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];
*
*
* @return The taskSpec.
*/
com.google.cloud.batch.v1alpha.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];
*
*/
com.google.cloud.batch.v1alpha.TaskSpecOrBuilder getTaskSpecOrBuilder();
/**
*
*
*
* Number of Tasks in the TaskGroup.
* default is 1
*
*
* int64 task_count = 4;
*
* @return The taskCount.
*/
long getTaskCount();
/**
*
*
*
* Max number of tasks that can run in parallel.
* Default to min(task_count, 1000).
*
*
* int64 parallelism = 5;
*
* @return The parallelism.
*/
long getParallelism();
/**
*
*
*
* Scheduling policy for Tasks in the TaskGroup.
*
*
* .google.cloud.batch.v1alpha.TaskGroup.SchedulingPolicy scheduling_policy = 6;
*
* @return The enum numeric value on the wire for schedulingPolicy.
*/
int getSchedulingPolicyValue();
/**
*
*
*
* Scheduling policy for Tasks in the TaskGroup.
*
*
* .google.cloud.batch.v1alpha.TaskGroup.SchedulingPolicy scheduling_policy = 6;
*
* @return The schedulingPolicy.
*/
com.google.cloud.batch.v1alpha.TaskGroup.SchedulingPolicy getSchedulingPolicy();
/**
*
*
*
* Compute resource allocation for the TaskGroup.
* If specified, it overrides resources in Job.
*
*
* .google.cloud.batch.v1alpha.AllocationPolicy allocation_policy = 7;
*
* @return Whether the allocationPolicy field is set.
*/
boolean hasAllocationPolicy();
/**
*
*
*
* Compute resource allocation for the TaskGroup.
* If specified, it overrides resources in Job.
*
*
* .google.cloud.batch.v1alpha.AllocationPolicy allocation_policy = 7;
*
* @return The allocationPolicy.
*/
com.google.cloud.batch.v1alpha.AllocationPolicy getAllocationPolicy();
/**
*
*
*
* Compute resource allocation for the TaskGroup.
* If specified, it overrides resources in Job.
*
*
* .google.cloud.batch.v1alpha.AllocationPolicy allocation_policy = 7;
*/
com.google.cloud.batch.v1alpha.AllocationPolicyOrBuilder getAllocationPolicyOrBuilder();
/**
*
*
*
* 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;
*/
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](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;
*/
boolean containsLabels(java.lang.String key);
/** Use {@link #getLabelsMap()} instead. */
@java.lang.Deprecated
java.util.Map getLabels();
/**
*
*
*
* 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;
*/
java.util.Map 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;
*/
/* nullable */
java.lang.String getLabelsOrDefault(
java.lang.String key,
/* nullable */
java.lang.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](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;
*/
java.lang.String getLabelsOrThrow(java.lang.String key);
/**
*
*
*
* 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.v1alpha.Environment task_environments = 9;
*/
java.util.List 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.v1alpha.Environment task_environments = 9;
*/
com.google.cloud.batch.v1alpha.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.v1alpha.Environment task_environments = 9;
*/
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.v1alpha.Environment task_environments = 9;
*/
java.util.List
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.v1alpha.Environment task_environments = 9;
*/
com.google.cloud.batch.v1alpha.EnvironmentOrBuilder getTaskEnvironmentsOrBuilder(int index);
/**
*
*
*
* 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;
*
* @return The taskCountPerNode.
*/
long getTaskCountPerNode();
/**
*
*
*
* 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;
*
* @return The requireHostsFile.
*/
boolean getRequireHostsFile();
/**
*
*
*
* When true, Batch will configure SSH to allow passwordless login between
* VMs running the Batch tasks in the same TaskGroup.
*
*
* bool permissive_ssh = 12;
*
* @return The permissiveSsh.
*/
boolean getPermissiveSsh();
}