Class: Google::Cloud::Batch::V1::TaskGroup

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/batch/v1/job.rb

Overview

A TaskGroup defines one or more Tasks that all share the same TaskSpec.

Defined Under Namespace

Modules: SchedulingPolicy

Instance Attribute Summary collapse

Instance Attribute Details

#name ⇒ ::String (readonly)

Returns 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".

Returns:

  • (::String) —

    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".



712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
 
# File 'proto_docs/google/cloud/batch/v1/job.rb', line 712

class TaskGroup
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # How Tasks in the TaskGroup should be scheduled relative to each other.
  module SchedulingPolicy
    # Unspecified.
    SCHEDULING_POLICY_UNSPECIFIED = 0

    # Run Tasks as soon as resources are available.
    #
    # Tasks might be executed in parallel depending on parallelism and
    # task_count values.
    AS_SOON_AS_POSSIBLE = 1

    # Run Tasks sequentially with increased task index.
    IN_ORDER = 2
  end
end

#parallelism ⇒ ::Integer

Returns Max number of tasks that can run in parallel. Default to min(task_count, parallel tasks per job limit). See: Job Limits. Field parallelism must be 1 if the scheduling_policy is IN_ORDER.

Returns:

  • (::Integer) —

    Max number of tasks that can run in parallel. Default to min(task_count, parallel tasks per job limit). See: Job Limits. Field parallelism must be 1 if the scheduling_policy is IN_ORDER.



712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
 
# File 'proto_docs/google/cloud/batch/v1/job.rb', line 712

class TaskGroup
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # How Tasks in the TaskGroup should be scheduled relative to each other.
  module SchedulingPolicy
    # Unspecified.
    SCHEDULING_POLICY_UNSPECIFIED = 0

    # Run Tasks as soon as resources are available.
    #
    # Tasks might be executed in parallel depending on parallelism and
    # task_count values.
    AS_SOON_AS_POSSIBLE = 1

    # Run Tasks sequentially with increased task index.
    IN_ORDER = 2
  end
end

#permissive_ssh ⇒ ::Boolean

Returns When true, Batch will configure SSH to allow passwordless login between VMs running the Batch tasks in the same TaskGroup.

Returns:

  • (::Boolean) —

    When true, Batch will configure SSH to allow passwordless login between VMs running the Batch tasks in the same TaskGroup.



712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
 
# File 'proto_docs/google/cloud/batch/v1/job.rb', line 712

class TaskGroup
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # How Tasks in the TaskGroup should be scheduled relative to each other.
  module SchedulingPolicy
    # Unspecified.
    SCHEDULING_POLICY_UNSPECIFIED = 0

    # Run Tasks as soon as resources are available.
    #
    # Tasks might be executed in parallel depending on parallelism and
    # task_count values.
    AS_SOON_AS_POSSIBLE = 1

    # Run Tasks sequentially with increased task index.
    IN_ORDER = 2
  end
end

#require_hosts_file ⇒ ::Boolean

Returns 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.

Returns:

  • (::Boolean) —

    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.



712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
 
# File 'proto_docs/google/cloud/batch/v1/job.rb', line 712

class TaskGroup
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # How Tasks in the TaskGroup should be scheduled relative to each other.
  module SchedulingPolicy
    # Unspecified.
    SCHEDULING_POLICY_UNSPECIFIED = 0

    # Run Tasks as soon as resources are available.
    #
    # Tasks might be executed in parallel depending on parallelism and
    # task_count values.
    AS_SOON_AS_POSSIBLE = 1

    # Run Tasks sequentially with increased task index.
    IN_ORDER = 2
  end
end

#run_as_non_root ⇒ ::Boolean

Returns 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.

Returns:

  • (::Boolean) —

    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.



712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
 
# File 'proto_docs/google/cloud/batch/v1/job.rb', line 712

class TaskGroup
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # How Tasks in the TaskGroup should be scheduled relative to each other.
  module SchedulingPolicy
    # Unspecified.
    SCHEDULING_POLICY_UNSPECIFIED = 0

    # Run Tasks as soon as resources are available.
    #
    # Tasks might be executed in parallel depending on parallelism and
    # task_count values.
    AS_SOON_AS_POSSIBLE = 1

    # Run Tasks sequentially with increased task index.
    IN_ORDER = 2
  end
end

#scheduling_policy ⇒ ::Google::Cloud::Batch::V1::TaskGroup::SchedulingPolicy

Returns Scheduling policy for Tasks in the TaskGroup. The default value is AS_SOON_AS_POSSIBLE.

Returns:



712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
 
# File 'proto_docs/google/cloud/batch/v1/job.rb', line 712

class TaskGroup
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # How Tasks in the TaskGroup should be scheduled relative to each other.
  module SchedulingPolicy
    # Unspecified.
    SCHEDULING_POLICY_UNSPECIFIED = 0

    # Run Tasks as soon as resources are available.
    #
    # Tasks might be executed in parallel depending on parallelism and
    # task_count values.
    AS_SOON_AS_POSSIBLE = 1

    # Run Tasks sequentially with increased task index.
    IN_ORDER = 2
  end
end

#task_count ⇒ ::Integer

Returns Number of Tasks in the TaskGroup. Default is 1.

Returns:

  • (::Integer) —

    Number of Tasks in the TaskGroup. Default is 1.



712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
 
# File 'proto_docs/google/cloud/batch/v1/job.rb', line 712

class TaskGroup
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # How Tasks in the TaskGroup should be scheduled relative to each other.
  module SchedulingPolicy
    # Unspecified.
    SCHEDULING_POLICY_UNSPECIFIED = 0

    # Run Tasks as soon as resources are available.
    #
    # Tasks might be executed in parallel depending on parallelism and
    # task_count values.
    AS_SOON_AS_POSSIBLE = 1

    # Run Tasks sequentially with increased task index.
    IN_ORDER = 2
  end
end

#task_count_per_node ⇒ ::Integer

Returns 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.

Returns:

  • (::Integer) —

    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.



712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
 
# File 'proto_docs/google/cloud/batch/v1/job.rb', line 712

class TaskGroup
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # How Tasks in the TaskGroup should be scheduled relative to each other.
  module SchedulingPolicy
    # Unspecified.
    SCHEDULING_POLICY_UNSPECIFIED = 0

    # Run Tasks as soon as resources are available.
    #
    # Tasks might be executed in parallel depending on parallelism and
    # task_count values.
    AS_SOON_AS_POSSIBLE = 1

    # Run Tasks sequentially with increased task index.
    IN_ORDER = 2
  end
end

#task_environments ⇒ ::Array<::Google::Cloud::Batch::V1::Environment>

Returns 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).

Returns:

  • (::Array<::Google::Cloud::Batch::V1::Environment>) —

    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).



712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
 
# File 'proto_docs/google/cloud/batch/v1/job.rb', line 712

class TaskGroup
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # How Tasks in the TaskGroup should be scheduled relative to each other.
  module SchedulingPolicy
    # Unspecified.
    SCHEDULING_POLICY_UNSPECIFIED = 0

    # Run Tasks as soon as resources are available.
    #
    # Tasks might be executed in parallel depending on parallelism and
    # task_count values.
    AS_SOON_AS_POSSIBLE = 1

    # Run Tasks sequentially with increased task index.
    IN_ORDER = 2
  end
end

#task_spec ⇒ ::Google::Cloud::Batch::V1::TaskSpec

Returns Required. Tasks in the group share the same task spec.

Returns:



712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
 
# File 'proto_docs/google/cloud/batch/v1/job.rb', line 712

class TaskGroup
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # How Tasks in the TaskGroup should be scheduled relative to each other.
  module SchedulingPolicy
    # Unspecified.
    SCHEDULING_POLICY_UNSPECIFIED = 0

    # Run Tasks as soon as resources are available.
    #
    # Tasks might be executed in parallel depending on parallelism and
    # task_count values.
    AS_SOON_AS_POSSIBLE = 1

    # Run Tasks sequentially with increased task index.
    IN_ORDER = 2
  end
end