Package com.google.cloud.batch.v1alpha

Interface TaskGroupOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
TaskGroup, TaskGroup.Builder
@Generated public interface TaskGroupOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getName

      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:
      The name.

    • getNameBytes

      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];
      Returns:
      The bytes for name.

    • hasTaskSpec

      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:
      Whether the taskSpec field is set.

    • getTaskSpec

      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:
      The taskSpec.

    • getTaskSpecOrBuilder

      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];

    • getTaskCount

      long getTaskCount()
       Number of Tasks in the TaskGroup.
 Default is 1.
      int64 task_count = 4;
      Returns:
      The taskCount.

    • getParallelism

      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;
      Returns:
      The parallelism.

    • getSchedulingPolicyValue

      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:
      The enum numeric value on the wire for schedulingPolicy.

    • getSchedulingPolicy

      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:
      The schedulingPolicy.

    • hasAllocationPolicy

      boolean hasAllocationPolicy()
       Compute resource allocation for the TaskGroup.
 If specified, it overrides resources in Job.
      .google.cloud.batch.v1alpha.AllocationPolicy allocation_policy = 7;
      Returns:
      Whether the allocationPolicy field is set.

    • getAllocationPolicy

      AllocationPolicy getAllocationPolicy()
       Compute resource allocation for the TaskGroup.
 If specified, it overrides resources in Job.
      .google.cloud.batch.v1alpha.AllocationPolicy allocation_policy = 7;
      Returns:
      The allocationPolicy.

    • getAllocationPolicyOrBuilder

      AllocationPolicyOrBuilder getAllocationPolicyOrBuilder()
       Compute resource allocation for the TaskGroup.
 If specified, it overrides resources in Job.
      .google.cloud.batch.v1alpha.AllocationPolicy allocation_policy = 7;

    • getLabelsCount

      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;

    • containsLabels

      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](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;

    • getLabels

      @Deprecated Map<String,String> getLabels()
      Deprecated.
      Use getLabelsMap() instead.

    • getLabelsMap

      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](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;

    • getLabelsOrDefault

      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](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;

    • getLabelsOrThrow

      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](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

      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;

    • getTaskEnvironments

      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;

    • getTaskEnvironmentsCount

      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;

    • getTaskEnvironmentsOrBuilderList

      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;

    • getTaskEnvironmentsOrBuilder

      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;

    • getTaskCountPerNode

      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:
      The taskCountPerNode.

    • getRequireHostsFile

      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:
      The requireHostsFile.

    • getPermissiveSsh

      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:
      The permissiveSsh.

    • getRunAsNonRoot

      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];
      Returns:
      The runAsNonRoot.

    • hasServiceAccount

      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:
      Whether the serviceAccount field is set.

    • getServiceAccount

      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:
      The serviceAccount.

    • getServiceAccountOrBuilder

      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];