Struct NotebookRuntimeTemplate 

#[non_exhaustive]
pub struct NotebookRuntimeTemplate {

    pub name: String,
    pub display_name: String,
    pub description: String,
    pub is_default: bool,
    pub machine_spec: Option<MachineSpec>,
    pub data_persistent_disk_spec: Option<PersistentDiskSpec>,
    pub network_spec: Option<NetworkSpec>,
    pub service_account: String,
    pub etag: String,
    pub labels: HashMap<String, String>,
    pub idle_shutdown_config: Option<NotebookIdleShutdownConfig>,
    pub euc_config: Option<NotebookEucConfig>,
    pub create_time: Option<Timestamp>,
    pub update_time: Option<Timestamp>,
    pub notebook_runtime_type: NotebookRuntimeType,
    pub shielded_vm_config: Option<ShieldedVmConfig>,
    pub network_tags: Vec<String>,
    pub encryption_spec: Option<EncryptionSpec>,
    pub software_config: Option<NotebookSoftwareConfig>,
    /* private fields */
}

Available on crate feature notebook-service only.

A template that specifies runtime configurations such as machine type, runtime version, network configurations, etc. Multiple runtimes can be created from a runtime template.

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.

name: String

The resource name of the NotebookRuntimeTemplate.

display_name: String

Required. The display name of the NotebookRuntimeTemplate. The name can be up to 128 characters long and can consist of any UTF-8 characters.

description: String

The description of the NotebookRuntimeTemplate.

is_default: bool

👎Deprecated

Output only. Deprecated: This field has no behavior. Use notebook_runtime_type = ‘ONE_CLICK’ instead.

The default template to use if not specified.

machine_spec: Option<MachineSpec>

Optional. Immutable. The specification of a single machine for the template.

data_persistent_disk_spec: Option<PersistentDiskSpec>

Optional. The specification of [persistent disk][https://cloud.google.com/compute/docs/disks/persistent-disks] attached to the runtime as data disk storage.

network_spec: Option<NetworkSpec>

Optional. Network spec.

service_account: String

👎Deprecated

Deprecated: This field is ignored and the “Vertex AI Notebook Service Account” (service-PROJECT_NUMBER@gcp-sa-aiplatform-vm.iam.gserviceaccount.com) is used for the runtime workload identity. See https://cloud.google.com/iam/docs/service-agents#vertex-ai-notebook-service-account for more details. For NotebookExecutionJob, use NotebookExecutionJob.service_account instead.

The service account that the runtime workload runs as. You can use any service account within the same project, but you must have the service account user permission to use the instance.

If not specified, the Compute Engine default service account is used.

etag: String

Used to perform consistent read-modify-write updates. If not set, a blind “overwrite” update happens.

labels: HashMap<String, String>

The labels with user-defined metadata to organize the NotebookRuntimeTemplates.

Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed.

See https://goo.gl/xmQnxf for more information and examples of labels.

idle_shutdown_config: Option<NotebookIdleShutdownConfig>

The idle shutdown configuration of NotebookRuntimeTemplate. This config will only be set when idle shutdown is enabled.

euc_config: Option<NotebookEucConfig>

EUC configuration of the NotebookRuntimeTemplate.

create_time: Option<Timestamp>

Output only. Timestamp when this NotebookRuntimeTemplate was created.

update_time: Option<Timestamp>

Output only. Timestamp when this NotebookRuntimeTemplate was most recently updated.

notebook_runtime_type: NotebookRuntimeType

Optional. Immutable. The type of the notebook runtime template.

shielded_vm_config: Option<ShieldedVmConfig>

Optional. Immutable. Runtime Shielded VM spec.

network_tags: Vec<String>

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

encryption_spec: Option<EncryptionSpec>

Customer-managed encryption key spec for the notebook runtime.

software_config: Option<NotebookSoftwareConfig>

Optional. The notebook software configuration of the notebook runtime.

Implementations

impl NotebookRuntimeTemplate

pub fn new() -> Self

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

Sets the value of name.

Example

let x = NotebookRuntimeTemplate::new().set_name("example");

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

Sets the value of display_name.

Example

let x = NotebookRuntimeTemplate::new().set_display_name("example");

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

Sets the value of description.

Example

let x = NotebookRuntimeTemplate::new().set_description("example");

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

👎Deprecated

Sets the value of is_default.

Example

let x = NotebookRuntimeTemplate::new().set_is_default(true);

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 = NotebookRuntimeTemplate::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 = NotebookRuntimeTemplate::new().set_or_clear_machine_spec(Some(MachineSpec::default()/* use setters */));
let x = NotebookRuntimeTemplate::new().set_or_clear_machine_spec(None::<MachineSpec>);

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

where T: Into<PersistentDiskSpec>,

Sets the value of data_persistent_disk_spec.

Example

use google_cloud_aiplatform_v1::model::PersistentDiskSpec;
let x = NotebookRuntimeTemplate::new().set_data_persistent_disk_spec(PersistentDiskSpec::default()/* use setters */);

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

where T: Into<PersistentDiskSpec>,

Sets or clears the value of data_persistent_disk_spec.

Example

use google_cloud_aiplatform_v1::model::PersistentDiskSpec;
let x = NotebookRuntimeTemplate::new().set_or_clear_data_persistent_disk_spec(Some(PersistentDiskSpec::default()/* use setters */));
let x = NotebookRuntimeTemplate::new().set_or_clear_data_persistent_disk_spec(None::<PersistentDiskSpec>);

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

where T: Into<NetworkSpec>,

Sets the value of network_spec.

Example

use google_cloud_aiplatform_v1::model::NetworkSpec;
let x = NotebookRuntimeTemplate::new().set_network_spec(NetworkSpec::default()/* use setters */);

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

where T: Into<NetworkSpec>,

Sets or clears the value of network_spec.

Example

use google_cloud_aiplatform_v1::model::NetworkSpec;
let x = NotebookRuntimeTemplate::new().set_or_clear_network_spec(Some(NetworkSpec::default()/* use setters */));
let x = NotebookRuntimeTemplate::new().set_or_clear_network_spec(None::<NetworkSpec>);

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

👎Deprecated

Sets the value of service_account.

Example

let x = NotebookRuntimeTemplate::new().set_service_account("example");

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

Sets the value of etag.

Example

let x = NotebookRuntimeTemplate::new().set_etag("example");

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

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

Sets the value of labels.

Example

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

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

where T: Into<NotebookIdleShutdownConfig>,

Sets the value of idle_shutdown_config.

Example

use google_cloud_aiplatform_v1::model::NotebookIdleShutdownConfig;
let x = NotebookRuntimeTemplate::new().set_idle_shutdown_config(NotebookIdleShutdownConfig::default()/* use setters */);

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

where T: Into<NotebookIdleShutdownConfig>,

Sets or clears the value of idle_shutdown_config.

Example

use google_cloud_aiplatform_v1::model::NotebookIdleShutdownConfig;
let x = NotebookRuntimeTemplate::new().set_or_clear_idle_shutdown_config(Some(NotebookIdleShutdownConfig::default()/* use setters */));
let x = NotebookRuntimeTemplate::new().set_or_clear_idle_shutdown_config(None::<NotebookIdleShutdownConfig>);

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

where T: Into<NotebookEucConfig>,

Sets the value of euc_config.

Example

use google_cloud_aiplatform_v1::model::NotebookEucConfig;
let x = NotebookRuntimeTemplate::new().set_euc_config(NotebookEucConfig::default()/* use setters */);

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

where T: Into<NotebookEucConfig>,

Sets or clears the value of euc_config.

Example

use google_cloud_aiplatform_v1::model::NotebookEucConfig;
let x = NotebookRuntimeTemplate::new().set_or_clear_euc_config(Some(NotebookEucConfig::default()/* use setters */));
let x = NotebookRuntimeTemplate::new().set_or_clear_euc_config(None::<NotebookEucConfig>);

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

where T: Into<Timestamp>,

Sets the value of create_time.

Example

use wkt::Timestamp;
let x = NotebookRuntimeTemplate::new().set_create_time(Timestamp::default()/* use setters */);

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

where T: Into<Timestamp>,

Sets or clears the value of create_time.

Example

use wkt::Timestamp;
let x = NotebookRuntimeTemplate::new().set_or_clear_create_time(Some(Timestamp::default()/* use setters */));
let x = NotebookRuntimeTemplate::new().set_or_clear_create_time(None::<Timestamp>);

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

where T: Into<Timestamp>,

Sets the value of update_time.

Example

use wkt::Timestamp;
let x = NotebookRuntimeTemplate::new().set_update_time(Timestamp::default()/* use setters */);

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

where T: Into<Timestamp>,

Sets or clears the value of update_time.

Example

use wkt::Timestamp;
let x = NotebookRuntimeTemplate::new().set_or_clear_update_time(Some(Timestamp::default()/* use setters */));
let x = NotebookRuntimeTemplate::new().set_or_clear_update_time(None::<Timestamp>);

pub fn set_notebook_runtime_type<T: Into<NotebookRuntimeType>>( self, v: T, ) -> Self

Sets the value of notebook_runtime_type.

Example

use google_cloud_aiplatform_v1::model::NotebookRuntimeType;
let x0 = NotebookRuntimeTemplate::new().set_notebook_runtime_type(NotebookRuntimeType::UserDefined);
let x1 = NotebookRuntimeTemplate::new().set_notebook_runtime_type(NotebookRuntimeType::OneClick);

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

where T: Into<ShieldedVmConfig>,

Sets the value of shielded_vm_config.

Example

use google_cloud_aiplatform_v1::model::ShieldedVmConfig;
let x = NotebookRuntimeTemplate::new().set_shielded_vm_config(ShieldedVmConfig::default()/* use setters */);

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

where T: Into<ShieldedVmConfig>,

Sets or clears the value of shielded_vm_config.

Example

use google_cloud_aiplatform_v1::model::ShieldedVmConfig;
let x = NotebookRuntimeTemplate::new().set_or_clear_shielded_vm_config(Some(ShieldedVmConfig::default()/* use setters */));
let x = NotebookRuntimeTemplate::new().set_or_clear_shielded_vm_config(None::<ShieldedVmConfig>);

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

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

Sets the value of network_tags.

Example

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

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

where T: Into<EncryptionSpec>,

Sets the value of encryption_spec.

Example

use google_cloud_aiplatform_v1::model::EncryptionSpec;
let x = NotebookRuntimeTemplate::new().set_encryption_spec(EncryptionSpec::default()/* use setters */);

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

where T: Into<EncryptionSpec>,

Sets or clears the value of encryption_spec.

Example

use google_cloud_aiplatform_v1::model::EncryptionSpec;
let x = NotebookRuntimeTemplate::new().set_or_clear_encryption_spec(Some(EncryptionSpec::default()/* use setters */));
let x = NotebookRuntimeTemplate::new().set_or_clear_encryption_spec(None::<EncryptionSpec>);

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

where T: Into<NotebookSoftwareConfig>,

Sets the value of software_config.

Example

use google_cloud_aiplatform_v1::model::NotebookSoftwareConfig;
let x = NotebookRuntimeTemplate::new().set_software_config(NotebookSoftwareConfig::default()/* use setters */);

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

where T: Into<NotebookSoftwareConfig>,

Sets or clears the value of software_config.

Example

use google_cloud_aiplatform_v1::model::NotebookSoftwareConfig;
let x = NotebookRuntimeTemplate::new().set_or_clear_software_config(Some(NotebookSoftwareConfig::default()/* use setters */));
let x = NotebookRuntimeTemplate::new().set_or_clear_software_config(None::<NotebookSoftwareConfig>);

Trait Implementations

impl Clone for NotebookRuntimeTemplate

fn clone(&self) -> NotebookRuntimeTemplate

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NotebookRuntimeTemplate

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

Formats the value using the given formatter.

impl Default for NotebookRuntimeTemplate

fn default() -> NotebookRuntimeTemplate

Returns the “default value” for a type.

impl Message for NotebookRuntimeTemplate

fn typename() -> &'static str

The typename of this message.

impl PartialEq for NotebookRuntimeTemplate

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for NotebookRuntimeTemplate