Batch V1 API - Class Google::Cloud::Batch::V1::TaskGroup (v0.20.0)

Reference documentation and code samples for the Batch V1 API class Google::Cloud::Batch::V1::TaskGroup.

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

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#name

def name() -> ::String
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".

#parallelism

def parallelism() -> ::Integer
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.

#parallelism=

def parallelism=(value) -> ::Integer
Parameter
  • value (::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.
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.

#permissive_ssh

def permissive_ssh() -> ::Boolean
Returns
  • (::Boolean) — When true, Batch will configure SSH to allow passwordless login between VMs running the Batch tasks in the same TaskGroup.

#permissive_ssh=

def permissive_ssh=(value) -> ::Boolean
Parameter
  • value (::Boolean) — 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.

#require_hosts_file

def require_hosts_file() -> ::Boolean
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.

#require_hosts_file=

def require_hosts_file=(value) -> ::Boolean
Parameter
  • value (::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.
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.

#run_as_non_root

def run_as_non_root() -> ::Boolean
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.

#run_as_non_root=

def run_as_non_root=(value) -> ::Boolean
Parameter
  • value (::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.
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.

#scheduling_policy

def scheduling_policy() -> ::Google::Cloud::Batch::V1::TaskGroup::SchedulingPolicy
Returns

#scheduling_policy=

def scheduling_policy=(value) -> ::Google::Cloud::Batch::V1::TaskGroup::SchedulingPolicy
Parameter
Returns

#task_count

def task_count() -> ::Integer
Returns
  • (::Integer) — Number of Tasks in the TaskGroup. Default is 1.

#task_count=

def task_count=(value) -> ::Integer
Parameter
  • value (::Integer) — Number of Tasks in the TaskGroup. Default is 1.
Returns
  • (::Integer) — Number of Tasks in the TaskGroup. Default is 1.

#task_count_per_node

def task_count_per_node() -> ::Integer
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.

#task_count_per_node=

def task_count_per_node=(value) -> ::Integer
Parameter
  • value (::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.
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.

#task_environments

def task_environments() -> ::Array<::Google::Cloud::Batch::V1::Environment>
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).

#task_environments=

def task_environments=(value) -> ::Array<::Google::Cloud::Batch::V1::Environment>
Parameter
  • value (::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).

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

#task_spec

def task_spec() -> ::Google::Cloud::Batch::V1::TaskSpec
Returns

#task_spec=

def task_spec=(value) -> ::Google::Cloud::Batch::V1::TaskSpec
Parameter
Returns