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 contains one or multiple Tasks that share the same Runnable but with different runtime parameters.

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



547
548
549
550
 
# File 'proto_docs/google/cloud/batch/v1/job.rb', line 547

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

#parallelism ⇒ ::Integer

Returns Max number of tasks that can run in parallel. Default to min(task_count, 1000).

Returns:

  • (::Integer) —

    Max number of tasks that can run in parallel. Default to min(task_count, 1000).



547
548
549
550
 
# File 'proto_docs/google/cloud/batch/v1/job.rb', line 547

class TaskGroup
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
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.



547
548
549
550
 
# File 'proto_docs/google/cloud/batch/v1/job.rb', line 547

class TaskGroup
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
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.

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.



547
548
549
550
 
# File 'proto_docs/google/cloud/batch/v1/job.rb', line 547

class TaskGroup
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
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



547
548
549
550
 
# File 'proto_docs/google/cloud/batch/v1/job.rb', line 547

class TaskGroup
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
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.



547
548
549
550
 
# File 'proto_docs/google/cloud/batch/v1/job.rb', line 547

class TaskGroup
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
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).

task_environments supports up to 200 entries.

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 supports up to 200 entries.



547
548
549
550
 
# File 'proto_docs/google/cloud/batch/v1/job.rb', line 547

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

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

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

Returns:



547
548
549
550
 
# File 'proto_docs/google/cloud/batch/v1/job.rb', line 547

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