Struct GceSetup 

#[non_exhaustive]
pub struct GceSetup {

    pub machine_type: String,
    pub accelerator_configs: Vec<AcceleratorConfig>,
    pub service_accounts: Vec<ServiceAccount>,
    pub boot_disk: Option<BootDisk>,
    pub data_disks: Vec<DataDisk>,
    pub shielded_instance_config: Option<ShieldedInstanceConfig>,
    pub network_interfaces: Vec<NetworkInterface>,
    pub disable_public_ip: bool,
    pub tags: Vec<String>,
    pub metadata: HashMap<String, String>,
    pub enable_ip_forwarding: bool,
    pub gpu_driver_config: Option<GPUDriverConfig>,
    pub image: Option<Image>,
    /* private fields */
}

The definition of how to configure a VM instance outside of Resources and Identity.

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_type: String

Optional. The machine type of the VM instance. https://cloud.google.com/compute/docs/machine-resource

accelerator_configs: Vec<AcceleratorConfig>

Optional. The hardware accelerators used on this instance. If you use accelerators, make sure that your configuration has enough vCPUs and memory to support the machine_type you have selected. Currently supports only one accelerator configuration.

service_accounts: Vec<ServiceAccount>

Optional. The service account that serves as an identity for the VM instance. Currently supports only one service account.

boot_disk: Option<BootDisk>

Optional. The boot disk for the VM.

data_disks: Vec<DataDisk>

Optional. Data disks attached to the VM instance. Currently supports only one data disk.

shielded_instance_config: Option<ShieldedInstanceConfig>

Optional. Shielded VM configuration. Images using supported Shielded VM features.

network_interfaces: Vec<NetworkInterface>

Optional. The network interfaces for the VM. Supports only one interface.

disable_public_ip: bool

Optional. If true, no external IP will be assigned to this VM instance.

tags: Vec<String>

Optional. The Compute Engine tags to add to runtime (see Tagging instances).

metadata: HashMap<String, String>

Optional. Custom metadata to apply to this instance.

enable_ip_forwarding: bool

Optional. Flag to enable ip forwarding or not, default false/off. https://cloud.google.com/vpc/docs/using-routes#canipforward

gpu_driver_config: Option<GPUDriverConfig>

Optional. Configuration for GPU drivers.

image: Option<Image>

Type of the image; can be one of VM image, or container image.

Implementations

impl GceSetup

pub fn new() -> Self

Creates a new default instance.

pub fn set_machine_type<T: Into<String>>(self, v: T) -> Self

Sets the value of machine_type.

Example

let x = GceSetup::new().set_machine_type("example");

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

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

Sets the value of accelerator_configs.

Example

use google_cloud_notebooks_v2::model::AcceleratorConfig;
let x = GceSetup::new()
    .set_accelerator_configs([
        AcceleratorConfig::default()/* use setters */,
        AcceleratorConfig::default()/* use (different) setters */,
    ]);

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

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

Sets the value of service_accounts.

Example

use google_cloud_notebooks_v2::model::ServiceAccount;
let x = GceSetup::new()
    .set_service_accounts([
        ServiceAccount::default()/* use setters */,
        ServiceAccount::default()/* use (different) setters */,
    ]);

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

where T: Into<BootDisk>,

Sets the value of boot_disk.

Example

use google_cloud_notebooks_v2::model::BootDisk;
let x = GceSetup::new().set_boot_disk(BootDisk::default()/* use setters */);

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

where T: Into<BootDisk>,

Sets or clears the value of boot_disk.

Example

use google_cloud_notebooks_v2::model::BootDisk;
let x = GceSetup::new().set_or_clear_boot_disk(Some(BootDisk::default()/* use setters */));
let x = GceSetup::new().set_or_clear_boot_disk(None::<BootDisk>);

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

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

Sets the value of data_disks.

Example

use google_cloud_notebooks_v2::model::DataDisk;
let x = GceSetup::new()
    .set_data_disks([
        DataDisk::default()/* use setters */,
        DataDisk::default()/* use (different) setters */,
    ]);

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

where T: Into<ShieldedInstanceConfig>,

Sets the value of shielded_instance_config.

Example

use google_cloud_notebooks_v2::model::ShieldedInstanceConfig;
let x = GceSetup::new().set_shielded_instance_config(ShieldedInstanceConfig::default()/* use setters */);

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

where T: Into<ShieldedInstanceConfig>,

Sets or clears the value of shielded_instance_config.

Example

use google_cloud_notebooks_v2::model::ShieldedInstanceConfig;
let x = GceSetup::new().set_or_clear_shielded_instance_config(Some(ShieldedInstanceConfig::default()/* use setters */));
let x = GceSetup::new().set_or_clear_shielded_instance_config(None::<ShieldedInstanceConfig>);

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

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

Sets the value of network_interfaces.

Example

use google_cloud_notebooks_v2::model::NetworkInterface;
let x = GceSetup::new()
    .set_network_interfaces([
        NetworkInterface::default()/* use setters */,
        NetworkInterface::default()/* use (different) setters */,
    ]);

pub fn set_disable_public_ip<T: Into<bool>>(self, v: T) -> Self

Sets the value of disable_public_ip.

Example

let x = GceSetup::new().set_disable_public_ip(true);

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

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

Sets the value of tags.

Example

let x = GceSetup::new().set_tags(["a", "b", "c"]);

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

where T: IntoIterator<Item = (K, V)>, K: Into<String>, V: Into<String>,

Sets the value of metadata.

Example

let x = GceSetup::new().set_metadata([
    ("key0", "abc"),
    ("key1", "xyz"),
]);

pub fn set_enable_ip_forwarding<T: Into<bool>>(self, v: T) -> Self

Sets the value of enable_ip_forwarding.

Example

let x = GceSetup::new().set_enable_ip_forwarding(true);

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

where T: Into<GPUDriverConfig>,

Sets the value of gpu_driver_config.

Example

use google_cloud_notebooks_v2::model::GPUDriverConfig;
let x = GceSetup::new().set_gpu_driver_config(GPUDriverConfig::default()/* use setters */);

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

where T: Into<GPUDriverConfig>,

Sets or clears the value of gpu_driver_config.

Example

use google_cloud_notebooks_v2::model::GPUDriverConfig;
let x = GceSetup::new().set_or_clear_gpu_driver_config(Some(GPUDriverConfig::default()/* use setters */));
let x = GceSetup::new().set_or_clear_gpu_driver_config(None::<GPUDriverConfig>);

pub fn set_image<T: Into<Option<Image>>>(self, v: T) -> Self

Sets the value of image.

Note that all the setters affecting image are mutually exclusive.

Example

use google_cloud_notebooks_v2::model::VmImage;
let x = GceSetup::new().set_image(Some(
    google_cloud_notebooks_v2::model::gce_setup::Image::VmImage(VmImage::default().into())));

pub fn vm_image(&self) -> Option<&Box<VmImage>>

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

pub fn set_vm_image<T: Into<Box<VmImage>>>(self, v: T) -> Self

Sets the value of image to hold a VmImage.

Note that all the setters affecting image are mutually exclusive.

Example

use google_cloud_notebooks_v2::model::VmImage;
let x = GceSetup::new().set_vm_image(VmImage::default()/* use setters */);
assert!(x.vm_image().is_some());
assert!(x.container_image().is_none());

pub fn container_image(&self) -> Option<&Box<ContainerImage>>

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

pub fn set_container_image<T: Into<Box<ContainerImage>>>(self, v: T) -> Self

Sets the value of image to hold a ContainerImage.

Note that all the setters affecting image are mutually exclusive.

Example

use google_cloud_notebooks_v2::model::ContainerImage;
let x = GceSetup::new().set_container_image(ContainerImage::default()/* use setters */);
assert!(x.container_image().is_some());
assert!(x.vm_image().is_none());

Trait Implementations

impl Clone for GceSetup

fn clone(&self) -> GceSetup

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GceSetup

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

Formats the value using the given formatter.

impl Default for GceSetup

fn default() -> GceSetup

Returns the “default value” for a type.

impl Message for GceSetup

fn typename() -> &'static str

The typename of this message.

impl PartialEq for GceSetup

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for GceSetup