Vertex AI V1 API - Class Google::Cloud::AIPlatform::V1::NotebookRuntimeTemplate (v0.41.0)

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

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

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 NotebookRuntimeTemplate was created.

#data_persistent_disk_spec

def data_persistent_disk_spec() -> ::Google::Cloud::AIPlatform::V1::PersistentDiskSpec

Returns

(::Google::Cloud::AIPlatform::V1::PersistentDiskSpec) — Optional. The specification of [persistent disk][https://cloud.google.com/compute/docs/disks/persistent-disks] attached to the runtime as data disk storage.

#data_persistent_disk_spec=

def data_persistent_disk_spec=(value) -> ::Google::Cloud::AIPlatform::V1::PersistentDiskSpec

Parameter

value (::Google::Cloud::AIPlatform::V1::PersistentDiskSpec) — Optional. The specification of [persistent disk][https://cloud.google.com/compute/docs/disks/persistent-disks] attached to the runtime as data disk storage.

Returns

(::Google::Cloud::AIPlatform::V1::PersistentDiskSpec) — Optional. The specification of [persistent disk][https://cloud.google.com/compute/docs/disks/persistent-disks] attached to the runtime as data disk storage.

#description

def description() -> ::String

Returns

(::String) — The description of the NotebookRuntimeTemplate.

#description=

def description=(value) -> ::String

Parameter

value (::String) — The description of the NotebookRuntimeTemplate.

Returns

(::String) — The description of the NotebookRuntimeTemplate.

#display_name

def display_name() -> ::String

Returns

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

#display_name=

def display_name=(value) -> ::String

Parameter

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

Returns

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

#encryption_spec

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

Returns

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

#encryption_spec=

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

Parameter

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

Returns

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

#etag

def etag() -> ::String

Returns

(::String) — Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.

#etag=

def etag=(value) -> ::String

Parameter

value (::String) — Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.

Returns

(::String) — Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.

#euc_config

def euc_config() -> ::Google::Cloud::AIPlatform::V1::NotebookEucConfig

Returns

(::Google::Cloud::AIPlatform::V1::NotebookEucConfig) — EUC configuration of the NotebookRuntimeTemplate.

#euc_config=

def euc_config=(value) -> ::Google::Cloud::AIPlatform::V1::NotebookEucConfig

Parameter

value (::Google::Cloud::AIPlatform::V1::NotebookEucConfig) — EUC configuration of the NotebookRuntimeTemplate.

Returns

(::Google::Cloud::AIPlatform::V1::NotebookEucConfig) — EUC configuration of the NotebookRuntimeTemplate.

#idle_shutdown_config

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

Returns

(::Google::Cloud::AIPlatform::V1::NotebookIdleShutdownConfig) — The idle shutdown configuration of NotebookRuntimeTemplate. This config will only be set when idle shutdown is enabled.

#idle_shutdown_config=

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

Parameter

value (::Google::Cloud::AIPlatform::V1::NotebookIdleShutdownConfig) — The idle shutdown configuration of NotebookRuntimeTemplate. This config will only be set when idle shutdown is enabled.

Returns

(::Google::Cloud::AIPlatform::V1::NotebookIdleShutdownConfig) — The idle shutdown configuration of NotebookRuntimeTemplate. This config will only be set when idle shutdown is enabled.

#is_default

def is_default() -> ::Boolean

Returns

(::Boolean) — Output only. The default template to use if not specified.

#labels

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

Returns

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

#labels=

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

Parameter

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

Returns

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

#machine_spec

def machine_spec() -> ::Google::Cloud::AIPlatform::V1::MachineSpec

Returns

(::Google::Cloud::AIPlatform::V1::MachineSpec) — Optional. Immutable. The specification of a single machine for the template.

#machine_spec=

def machine_spec=(value) -> ::Google::Cloud::AIPlatform::V1::MachineSpec

Parameter

value (::Google::Cloud::AIPlatform::V1::MachineSpec) — Optional. Immutable. The specification of a single machine for the template.

Returns

(::Google::Cloud::AIPlatform::V1::MachineSpec) — Optional. Immutable. The specification of a single machine for the template.

#name

def name() -> ::String

Returns

(::String) — The resource name of the NotebookRuntimeTemplate.

#name=

def name=(value) -> ::String

Parameter

value (::String) — The resource name of the NotebookRuntimeTemplate.

Returns

(::String) — The resource name of the NotebookRuntimeTemplate.

#network_spec

def network_spec() -> ::Google::Cloud::AIPlatform::V1::NetworkSpec

Returns

(::Google::Cloud::AIPlatform::V1::NetworkSpec) — Optional. Network spec.

#network_spec=

def network_spec=(value) -> ::Google::Cloud::AIPlatform::V1::NetworkSpec

Parameter

value (::Google::Cloud::AIPlatform::V1::NetworkSpec) — Optional. Network spec.

Returns

(::Google::Cloud::AIPlatform::V1::NetworkSpec) — Optional. Network spec.

#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_type

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

Returns

(::Google::Cloud::AIPlatform::V1::NotebookRuntimeType) — Optional. Immutable. The type of the notebook runtime template.

#notebook_runtime_type=

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

Parameter

value (::Google::Cloud::AIPlatform::V1::NotebookRuntimeType) — Optional. Immutable. The type of the notebook runtime template.

Returns

(::Google::Cloud::AIPlatform::V1::NotebookRuntimeType) — Optional. Immutable. The type of the notebook runtime template.

#service_account

def service_account() -> ::String

Returns

(::String) — 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.

#service_account=

def service_account=(value) -> ::String

Parameter

value (::String) — 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.

Returns

(::String) — 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.

#shielded_vm_config

def shielded_vm_config() -> ::Google::Cloud::AIPlatform::V1::ShieldedVmConfig

Returns

(::Google::Cloud::AIPlatform::V1::ShieldedVmConfig) — Optional. Immutable. Runtime Shielded VM spec.

#shielded_vm_config=

def shielded_vm_config=(value) -> ::Google::Cloud::AIPlatform::V1::ShieldedVmConfig

Parameter

value (::Google::Cloud::AIPlatform::V1::ShieldedVmConfig) — Optional. Immutable. Runtime Shielded VM spec.

Returns

(::Google::Cloud::AIPlatform::V1::ShieldedVmConfig) — Optional. Immutable. Runtime Shielded VM spec.

#update_time

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

Returns

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