Struct NotebookRuntime

#[non_exhaustive]
pub struct NotebookRuntime {

    pub name: String,
    pub runtime_user: String,
    pub notebook_runtime_template_ref: Option<NotebookRuntimeTemplateRef>,
    pub proxy_uri: String,
    pub create_time: Option<Timestamp>,
    pub update_time: Option<Timestamp>,
    pub health_state: HealthState,
    pub display_name: String,
    pub description: String,
    pub service_account: String,
    pub runtime_state: RuntimeState,
    pub is_upgradable: bool,
    pub labels: HashMap<String, String>,
    pub expiration_time: Option<Timestamp>,
    pub version: String,
    pub notebook_runtime_type: NotebookRuntimeType,
    pub machine_spec: Option<MachineSpec>,
    pub data_persistent_disk_spec: Option<PersistentDiskSpec>,
    pub network_spec: Option<NetworkSpec>,
    pub idle_shutdown_config: Option<NotebookIdleShutdownConfig>,
    pub euc_config: Option<NotebookEucConfig>,
    pub shielded_vm_config: Option<ShieldedVmConfig>,
    pub network_tags: Vec<String>,
    pub software_config: Option<NotebookSoftwareConfig>,
    pub encryption_spec: Option<EncryptionSpec>,
    pub satisfies_pzs: bool,
    pub satisfies_pzi: bool,
    /* private fields */
}

A runtime is a virtual machine allocated to a particular user for a particular Notebook file on temporary basis with lifetime limited to 24 hours.

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

Output only. The resource name of the NotebookRuntime.

runtime_user: String

Required. The user email of the NotebookRuntime.

notebook_runtime_template_ref: Option<NotebookRuntimeTemplateRef>

Output only. The pointer to NotebookRuntimeTemplate this NotebookRuntime is created from.

proxy_uri: String

Output only. The proxy endpoint used to access the NotebookRuntime.

create_time: Option<Timestamp>

Output only. Timestamp when this NotebookRuntime was created.

update_time: Option<Timestamp>

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

health_state: HealthState

Output only. The health state of the NotebookRuntime.

display_name: String

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

description: String

The description of the NotebookRuntime.

service_account: String

Output only. Deprecated: This field is no longer used 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.

The service account that the NotebookRuntime workload runs as.

runtime_state: RuntimeState

Output only. The runtime (instance) state of the NotebookRuntime.

is_upgradable: bool

Output only. Whether NotebookRuntime is upgradable.

labels: HashMap<String, String>

The labels with user-defined metadata to organize your NotebookRuntime.

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. No more than 64 user labels can be associated with one NotebookRuntime (System labels are excluded).

See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with “aiplatform.googleapis.com/” and are immutable. Following system labels exist for NotebookRuntime:

• “aiplatform.googleapis.com/notebook_runtime_gce_instance_id”: output only, its value is the Compute Engine instance id.
• “aiplatform.googleapis.com/colab_enterprise_entry_service”: its value is either “bigquery” or “vertex”; if absent, it should be “vertex”. This is to describe the entry service, either BigQuery or Vertex.

expiration_time: Option<Timestamp>

Output only. Timestamp when this NotebookRuntime will be expired:

. System Predefined NotebookRuntime: 24 hours after creation. After expiration, system predifined runtime will be deleted. . User created NotebookRuntime: 6 months after last upgrade. After expiration, user created runtime will be stopped and allowed for upgrade.

version: String

Output only. The VM os image version of NotebookRuntime.

notebook_runtime_type: NotebookRuntimeType

Output only. The type of the notebook runtime.

machine_spec: Option<MachineSpec>

Output only. The specification of a single machine used by the notebook runtime.

data_persistent_disk_spec: Option<PersistentDiskSpec>

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

network_spec: Option<NetworkSpec>

Output only. Network spec of the notebook runtime.

idle_shutdown_config: Option<NotebookIdleShutdownConfig>

Output only. The idle shutdown configuration of the notebook runtime.

euc_config: Option<NotebookEucConfig>

Output only. EUC configuration of the notebook runtime.

shielded_vm_config: Option<ShieldedVmConfig>

Output only. Runtime Shielded VM spec.

network_tags: Vec<String>

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

software_config: Option<NotebookSoftwareConfig>

Output only. Software config of the notebook runtime.

encryption_spec: Option<EncryptionSpec>

Output only. Customer-managed encryption key spec for the notebook runtime.

satisfies_pzs: bool

Output only. Reserved for future use.

satisfies_pzi: bool

Output only. Reserved for future use.

Implementations

impl NotebookRuntime

pub fn new() -> Self

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

Sets the value of name.

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

Sets the value of runtime_user.

pub fn set_notebook_runtime_template_ref<T: Into<Option<NotebookRuntimeTemplateRef>>>( self, v: T, ) -> Self

Sets the value of notebook_runtime_template_ref.

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

Sets the value of proxy_uri.

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

Sets the value of create_time.

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

Sets the value of update_time.

pub fn set_health_state<T: Into<HealthState>>(self, v: T) -> Self

Sets the value of health_state.

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

Sets the value of display_name.

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

Sets the value of description.

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

Sets the value of service_account.

pub fn set_runtime_state<T: Into<RuntimeState>>(self, v: T) -> Self

Sets the value of runtime_state.

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

Sets the value of is_upgradable.

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.

pub fn set_expiration_time<T: Into<Option<Timestamp>>>(self, v: T) -> Self

Sets the value of expiration_time.

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

Sets the value of version.

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

Sets the value of notebook_runtime_type.

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

Sets the value of machine_spec.

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

Sets the value of data_persistent_disk_spec.

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

Sets the value of network_spec.

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

Sets the value of idle_shutdown_config.

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

Sets the value of euc_config.

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

Sets the value of shielded_vm_config.

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.

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

Sets the value of software_config.

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

Sets the value of encryption_spec.

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

Sets the value of satisfies_pzs.

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

Sets the value of satisfies_pzi.

Trait Implementations

impl Clone for NotebookRuntime

fn clone(&self) -> NotebookRuntime

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NotebookRuntime

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

Formats the value using the given formatter.

impl Default for NotebookRuntime

fn default() -> NotebookRuntime

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for NotebookRuntime

where NotebookRuntime: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Message for NotebookRuntime

fn typename() -> &'static str

The typename of this message.

impl PartialEq for NotebookRuntime

fn eq(&self, other: &NotebookRuntime) -> 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 Serialize for NotebookRuntime

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for NotebookRuntime