Struct google_api_proto::google::cloud::aiplatform::v1beta1::NotebookRuntime

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: i32,
    pub display_name: String,
    pub description: String,
    pub service_account: String,
    pub runtime_state: i32,
    pub is_upgradable: bool,
    pub labels: BTreeMap<String, String>,
    pub expiration_time: Option<Timestamp>,
    pub version: String,
    pub notebook_runtime_type: i32,
    pub idle_shutdown_config: Option<NotebookIdleShutdownConfig>,
    pub network_tags: Vec<String>,
    pub encryption_spec: Option<EncryptionSpec>,
    pub satisfies_pzs: bool,
    pub satisfies_pzi: bool,
}

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

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: i32

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. The service account that the NotebookRuntime workload runs as.

runtime_state: i32

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

is_upgradable: bool

Output only. Whether NotebookRuntime is upgradable.

labels: BTreeMap<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:

1. System Predefined NotebookRuntime: 24 hours after creation. After expiration, system predifined runtime will be deleted.
2. 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: i32

Output only. The type of the notebook runtime.

idle_shutdown_config: Option<NotebookIdleShutdownConfig>

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

network_tags: Vec<String>

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

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 health_state(&self) -> HealthState

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

pub fn set_health_state(&mut self, value: HealthState)

Sets health_state to the provided enum value.

pub fn runtime_state(&self) -> RuntimeState

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

pub fn set_runtime_state(&mut self, value: RuntimeState)

Sets runtime_state to the provided enum value.

pub fn notebook_runtime_type(&self) -> NotebookRuntimeType

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

pub fn set_notebook_runtime_type(&mut self, value: NotebookRuntimeType)

Sets notebook_runtime_type to the provided enum value.

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() -> Self

Returns the “default value” for a type.

impl Message for NotebookRuntime

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 NotebookRuntime

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