Interface TaskGroupOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    TaskGroup, TaskGroup.Builder

    public interface TaskGroupOrBuilder
    extends com.google.protobuf.MessageOrBuilder
    • Method Detail

      • 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.v1.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.v1.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.v1.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, 1000).
         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.v1.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.v1.TaskGroup.SchedulingPolicy scheduling_policy = 6;
        Returns:
        The schedulingPolicy.
      • 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.v1.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.v1.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.v1.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.v1.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.v1.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.
         
        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.