Vertex AI V1 API - Class Google::Cloud::AIPlatform::V1::NotebookRuntime (v0.42.0)

Version latest

• 0.42.0 (latest)
• 0.41.0
• 0.40.0
• 0.39.0
• 0.38.0
• 0.37.0
• 0.36.0
• 0.35.0
• 0.34.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.1
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.0

Reference documentation and code samples for the Vertex AI V1 API class Google::Cloud::AIPlatform::V1::NotebookRuntime.

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.

Inherits

• Object

Extended By

• Google::Protobuf::MessageExts::ClassMethods

Includes

• Google::Protobuf::MessageExts

Methods

#create_time

def create_time() -> ::Google::Protobuf::Timestamp

Returns

• (::Google::Protobuf::Timestamp) — Output only. Timestamp when this NotebookRuntime was created.

#description

def description() -> ::String

Returns

• (::String) — The description of the NotebookRuntime.

#description=

def description=(value) -> ::String

Parameter

• value (::String) — The description of the NotebookRuntime.

Returns

• (::String) — The description of the NotebookRuntime.

#display_name

def display_name() -> ::String

Returns

• (::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.

#display_name=

def display_name=(value) -> ::String

Parameter

• value (::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.

Returns

• (::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.

#encryption_spec

def encryption_spec() -> ::Google::Cloud::AIPlatform::V1::EncryptionSpec

Returns

• (::Google::Cloud::AIPlatform::V1::EncryptionSpec) — Output only. Customer-managed encryption key spec for the notebook runtime.

#expiration_time

def expiration_time() -> ::Google::Protobuf::Timestamp

Returns

• (::Google::Protobuf::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.

#health_state

def health_state() -> ::Google::Cloud::AIPlatform::V1::NotebookRuntime::HealthState

Returns

• (::Google::Cloud::AIPlatform::V1::NotebookRuntime::HealthState) — Output only. The health state of the NotebookRuntime.

#idle_shutdown_config

def idle_shutdown_config() -> ::Google::Cloud::AIPlatform::V1::NotebookIdleShutdownConfig

Returns

• (::Google::Cloud::AIPlatform::V1::NotebookIdleShutdownConfig) — Output only. The idle shutdown configuration of the notebook runtime.

#is_upgradable

def is_upgradable() -> ::Boolean

Returns

• (::Boolean) — Output only. Whether NotebookRuntime is upgradable.

#labels

def labels() -> ::Google::Protobuf::Map{::String => ::String}

Returns

• (::Google::Protobuf::Map{::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.

#labels=

def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}

Parameter

• value (::Google::Protobuf::Map{::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.

Returns

• (::Google::Protobuf::Map{::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.

#name

def name() -> ::String

Returns

• (::String) — Output only. The resource name of the NotebookRuntime.

#network_tags

def network_tags() -> ::Array<::String>

Returns

• (::Array<::String>) — Optional. The Compute Engine tags to add to runtime (see Tagging instances).

#network_tags=

def network_tags=(value) -> ::Array<::String>

Parameter

• value (::Array<::String>) — Optional. The Compute Engine tags to add to runtime (see Tagging instances).

Returns

• (::Array<::String>) — Optional. The Compute Engine tags to add to runtime (see Tagging instances).

#notebook_runtime_template_ref

def notebook_runtime_template_ref() -> ::Google::Cloud::AIPlatform::V1::NotebookRuntimeTemplateRef

Returns

• (::Google::Cloud::AIPlatform::V1::NotebookRuntimeTemplateRef) — Output only. The pointer to NotebookRuntimeTemplate this NotebookRuntime is created from.

#notebook_runtime_type

def notebook_runtime_type() -> ::Google::Cloud::AIPlatform::V1::NotebookRuntimeType

Returns

• (::Google::Cloud::AIPlatform::V1::NotebookRuntimeType) — Output only. The type of the notebook runtime.

#proxy_uri

def proxy_uri() -> ::String

Returns

• (::String) — Output only. The proxy endpoint used to access the NotebookRuntime.

#runtime_state

def runtime_state() -> ::Google::Cloud::AIPlatform::V1::NotebookRuntime::RuntimeState

Returns

• (::Google::Cloud::AIPlatform::V1::NotebookRuntime::RuntimeState) — Output only. The runtime (instance) state of the NotebookRuntime.

#runtime_user

def runtime_user() -> ::String

Returns

• (::String) — Required. The user email of the NotebookRuntime.

#runtime_user=

def runtime_user=(value) -> ::String

Parameter

• value (::String) — Required. The user email of the NotebookRuntime.

Returns

• (::String) — Required. The user email of the NotebookRuntime.

#satisfies_pzi

def satisfies_pzi() -> ::Boolean

Returns

• (::Boolean) — Output only. Reserved for future use.

#satisfies_pzs

def satisfies_pzs() -> ::Boolean

Returns

• (::Boolean) — Output only. Reserved for future use.

#service_account

def service_account() -> ::String

Returns

• (::String) — Output only. The service account that the NotebookRuntime workload runs as.

#update_time

def update_time() -> ::Google::Protobuf::Timestamp

Returns

• (::Google::Protobuf::Timestamp) — Output only. Timestamp when this NotebookRuntime was most recently updated.

#version

def version() -> ::String

Returns

• (::String) — Output only. The VM os image version of NotebookRuntime.