Vertex AI V1 API - Class Google::Cloud::AIPlatform::V1::NotebookRuntimeTemplate (v0.40.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

#data_persistent_disk_spec

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

#data_persistent_disk_spec=

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

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

#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

#euc_config=

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

#idle_shutdown_config

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

#idle_shutdown_config=

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

#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

#machine_spec=

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

#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

#network_spec=

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

#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

#notebook_runtime_type=

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

#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

#shielded_vm_config=

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

#update_time

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