Struct WorkerPoolSpec 

#[non_exhaustive]
pub struct WorkerPoolSpec {
    pub machine_spec: Option<MachineSpec>,
    pub replica_count: i64,
    pub nfs_mounts: Vec<NfsMount>,
    pub lustre_mounts: Vec<LustreMount>,
    pub disk_spec: Option<DiskSpec>,
    pub task: Option<Task>,
    /* private fields */
}

Available on crate feature job-service only.

Represents the spec of a worker pool in a job.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

machine_spec: Option<MachineSpec>

Optional. Immutable. The specification of a single machine.

replica_count: i64

Optional. The number of worker replicas to use for this worker pool.

nfs_mounts: Vec<NfsMount>

Optional. List of NFS mount spec.

lustre_mounts: Vec<LustreMount>

Optional. List of Lustre mounts.

disk_spec: Option<DiskSpec>

Disk spec.

task: Option<Task>

The custom task to be executed in this worker pool.

Implementations

impl WorkerPoolSpec

pub fn new() -> Self

Creates a new default instance.

pub fn set_machine_spec<T>(self, v: T) -> Self

where T: Into<MachineSpec>,

Sets the value of machine_spec.

Example

use google_cloud_aiplatform_v1::model::MachineSpec;
let x = WorkerPoolSpec::new().set_machine_spec(MachineSpec::default()/* use setters */);

pub fn set_or_clear_machine_spec<T>(self, v: Option<T>) -> Self

where T: Into<MachineSpec>,

Sets or clears the value of machine_spec.

Example

use google_cloud_aiplatform_v1::model::MachineSpec;
let x = WorkerPoolSpec::new().set_or_clear_machine_spec(Some(MachineSpec::default()/* use setters */));
let x = WorkerPoolSpec::new().set_or_clear_machine_spec(None::<MachineSpec>);

pub fn set_replica_count<T: Into<i64>>(self, v: T) -> Self

Sets the value of replica_count.

Example

let x = WorkerPoolSpec::new().set_replica_count(42);

pub fn set_nfs_mounts<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<NfsMount>,

Sets the value of nfs_mounts.

Example

use google_cloud_aiplatform_v1::model::NfsMount;
let x = WorkerPoolSpec::new()
    .set_nfs_mounts([
        NfsMount::default()/* use setters */,
        NfsMount::default()/* use (different) setters */,
    ]);

pub fn set_lustre_mounts<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<LustreMount>,

Sets the value of lustre_mounts.

Example

use google_cloud_aiplatform_v1::model::LustreMount;
let x = WorkerPoolSpec::new()
    .set_lustre_mounts([
        LustreMount::default()/* use setters */,
        LustreMount::default()/* use (different) setters */,
    ]);

pub fn set_disk_spec<T>(self, v: T) -> Self

where T: Into<DiskSpec>,

Sets the value of disk_spec.

Example

use google_cloud_aiplatform_v1::model::DiskSpec;
let x = WorkerPoolSpec::new().set_disk_spec(DiskSpec::default()/* use setters */);

pub fn set_or_clear_disk_spec<T>(self, v: Option<T>) -> Self

where T: Into<DiskSpec>,

Sets or clears the value of disk_spec.

Example

use google_cloud_aiplatform_v1::model::DiskSpec;
let x = WorkerPoolSpec::new().set_or_clear_disk_spec(Some(DiskSpec::default()/* use setters */));
let x = WorkerPoolSpec::new().set_or_clear_disk_spec(None::<DiskSpec>);

pub fn set_task<T: Into<Option<Task>>>(self, v: T) -> Self

Sets the value of task.

Note that all the setters affecting task are mutually exclusive.

Example

use google_cloud_aiplatform_v1::model::ContainerSpec;
let x = WorkerPoolSpec::new().set_task(Some(
    google_cloud_aiplatform_v1::model::worker_pool_spec::Task::ContainerSpec(ContainerSpec::default().into())));

pub fn container_spec(&self) -> Option<&Box<ContainerSpec>>

The value of task if it holds a ContainerSpec, None if the field is not set or holds a different branch.

pub fn set_container_spec<T: Into<Box<ContainerSpec>>>(self, v: T) -> Self

Sets the value of task to hold a ContainerSpec.

Note that all the setters affecting task are mutually exclusive.

Example

use google_cloud_aiplatform_v1::model::ContainerSpec;
let x = WorkerPoolSpec::new().set_container_spec(ContainerSpec::default()/* use setters */);
assert!(x.container_spec().is_some());
assert!(x.python_package_spec().is_none());

pub fn python_package_spec(&self) -> Option<&Box<PythonPackageSpec>>

The value of task if it holds a PythonPackageSpec, None if the field is not set or holds a different branch.

pub fn set_python_package_spec<T: Into<Box<PythonPackageSpec>>>( self, v: T, ) -> Self

Sets the value of task to hold a PythonPackageSpec.

Note that all the setters affecting task are mutually exclusive.

Example

use google_cloud_aiplatform_v1::model::PythonPackageSpec;
let x = WorkerPoolSpec::new().set_python_package_spec(PythonPackageSpec::default()/* use setters */);
assert!(x.python_package_spec().is_some());
assert!(x.container_spec().is_none());

Trait Implementations

impl Clone for WorkerPoolSpec

fn clone(&self) -> WorkerPoolSpec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WorkerPoolSpec

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

Formats the value using the given formatter.

impl Default for WorkerPoolSpec

fn default() -> WorkerPoolSpec

Returns the “default value” for a type.

impl Message for WorkerPoolSpec

fn typename() -> &'static str

The typename of this message.

impl PartialEq for WorkerPoolSpec

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for WorkerPoolSpec