Struct google_api_proto::google::cloud::batch::v1::TaskGroup

pub struct TaskGroup {
    pub name: String,
    pub task_spec: Option<TaskSpec>,
    pub task_count: i64,
    pub parallelism: i64,
    pub scheduling_policy: i32,
    pub task_environments: Vec<Environment>,
    pub task_count_per_node: i64,
    pub require_hosts_file: bool,
    pub permissive_ssh: bool,
    pub run_as_non_root: bool,
}

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

Fields

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

task_spec: Option<TaskSpec>

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

task_count: i64

Number of Tasks in the TaskGroup. Default is 1.

parallelism: i64

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.

scheduling_policy: i32

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

task_environments: Vec<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_count_per_node: i64

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.

require_hosts_file: bool

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.

permissive_ssh: bool

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

run_as_non_root: bool

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.

Implementations

impl TaskGroup

pub fn scheduling_policy(&self) -> SchedulingPolicy

Returns the enum value of scheduling_policy, or the default if the field is set to an invalid enum value.

pub fn set_scheduling_policy(&mut self, value: SchedulingPolicy)

Sets scheduling_policy to the provided enum value.

Trait Implementations

impl Clone for TaskGroup

fn clone(&self) -> TaskGroup

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TaskGroup

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for TaskGroup

fn default() -> Self

Returns the “default value” for a type.

impl Message for TaskGroup

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for TaskGroup

fn eq(&self, other: &TaskGroup) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for TaskGroup