Class: Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1NotebookRuntimeTemplate

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/aiplatform_v1beta1/classes.rb,
lib/google/apis/aiplatform_v1beta1/representations.rb,
lib/google/apis/aiplatform_v1beta1/representations.rb

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudAiplatformV1beta1NotebookRuntimeTemplate

Returns a new instance of GoogleCloudAiplatformV1beta1NotebookRuntimeTemplate.



41101
41102
41103
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 41101

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#create_time ⇒ String

Output only. Timestamp when this NotebookRuntimeTemplate was created. Corresponds to the JSON property createTime

Returns:

  • (String) 


40980
40981
40982
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 40980

def create_time
  @create_time
end

#data_persistent_disk_spec ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1PersistentDiskSpec

Represents the spec of persistent disk and hyperdisk options. Corresponds to the JSON property dataPersistentDiskSpec

Returns:



40985
40986
40987
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 40985

def data_persistent_disk_spec
  @data_persistent_disk_spec
end

#description ⇒ String

The description of the NotebookRuntimeTemplate. Corresponds to the JSON property description

Returns:

  • (String) 


40990
40991
40992
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 40990

def description
  @description
end

#display_name ⇒ 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. Corresponds to the JSON property displayName

Returns:

  • (String) 


40996
40997
40998
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 40996

def display_name
  @display_name
end

#encryption_spec ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1EncryptionSpec

Represents a customer-managed encryption key specification that can be applied to a Vertex AI resource. Corresponds to the JSON property encryptionSpec

Returns:



41002
41003
41004
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 41002

def encryption_spec
  @encryption_spec
end

#etag ⇒ String

Used to perform consistent read-modify-write updates. If not set, a blind " overwrite" update happens. Corresponds to the JSON property etag

Returns:

  • (String) 


41008
41009
41010
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 41008

def etag
  @etag
end

#euc_config ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1NotebookEucConfig

The euc configuration of NotebookRuntimeTemplate. Corresponds to the JSON property eucConfig

Returns:



41013
41014
41015
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 41013

def euc_config
  @euc_config
end

#idle_shutdown_config ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1NotebookIdleShutdownConfig

The idle shutdown configuration of NotebookRuntimeTemplate, which contains the idle_timeout as required field. Corresponds to the JSON property idleShutdownConfig

Returns:



41019
41020
41021
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 41019

def idle_shutdown_config
  @idle_shutdown_config
end

#is_default ⇒ Boolean Also known as: is_default?

Output only. Deprecated: This field has no behavior. Use notebook_runtime_type = 'ONE_CLICK' instead. The default template to use if not specified. Corresponds to the JSON property isDefault

Returns:

  • (Boolean) 


41025
41026
41027
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 41025

def is_default
  @is_default
end

#labels ⇒ Hash<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. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


41035
41036
41037
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 41035

def labels
  @labels
end

#machine_spec ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1MachineSpec

Specification of a single machine. Corresponds to the JSON property machineSpec

Returns:



41040
41041
41042
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 41040

def machine_spec
  @machine_spec
end

#name ⇒ String

The resource name of the NotebookRuntimeTemplate. Corresponds to the JSON property name

Returns:

  • (String) 


41045
41046
41047
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 41045

def name
  @name
end

#network_spec ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1NetworkSpec

Network spec. Corresponds to the JSON property networkSpec

Returns:



41050
41051
41052
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 41050

def network_spec
  @network_spec
end

#network_tags ⇒ Array<String>

Optional. The Compute Engine tags to add to runtime (see Tagging instances). Corresponds to the JSON property networkTags

Returns:

  • (Array<String>) 


41056
41057
41058
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 41056

def network_tags
  @network_tags
end

#notebook_runtime_type ⇒ String

Optional. Immutable. The type of the notebook runtime template. Corresponds to the JSON property notebookRuntimeType

Returns:

  • (String) 


41061
41062
41063
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 41061

def notebook_runtime_type
  @notebook_runtime_type
end

#reservation_affinity ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1NotebookReservationAffinity

Notebook Reservation Affinity for consuming Zonal reservation. Corresponds to the JSON property reservationAffinity

Returns:



41066
41067
41068
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 41066

def reservation_affinity
  @reservation_affinity
end

#service_account ⇒ String

Deprecated: This field is ignored 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. For NotebookExecutionJob, use NotebookExecutionJob.service_account instead. 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. Corresponds to the JSON property serviceAccount

Returns:

  • (String) 


41080
41081
41082
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 41080

def 
  @service_account
end

#shielded_vm_config ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ShieldedVmConfig

A set of Shielded Instance options. See Images using supported Shielded VM features. Corresponds to the JSON property shieldedVmConfig

Returns:



41087
41088
41089
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 41087

def shielded_vm_config
  @shielded_vm_config
end

#software_config ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1NotebookSoftwareConfig

Notebook Software Config. This is passed to the backend when user makes software configurations in UI. Corresponds to the JSON property softwareConfig

Returns:



41093
41094
41095
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 41093

def software_config
  @software_config
end

#update_time ⇒ String

Output only. Timestamp when this NotebookRuntimeTemplate was most recently updated. Corresponds to the JSON property updateTime

Returns:

  • (String) 


41099
41100
41101
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 41099

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



41106
41107
41108
41109
41110
41111
41112
41113
41114
41115
41116
41117
41118
41119
41120
41121
41122
41123
41124
41125
41126
41127
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 41106

def update!(**args)
  @create_time = args[:create_time] if args.key?(:create_time)
  @data_persistent_disk_spec = args[:data_persistent_disk_spec] if args.key?(:data_persistent_disk_spec)
  @description = args[:description] if args.key?(:description)
  @display_name = args[:display_name] if args.key?(:display_name)
  @encryption_spec = args[:encryption_spec] if args.key?(:encryption_spec)
  @etag = args[:etag] if args.key?(:etag)
  @euc_config = args[:euc_config] if args.key?(:euc_config)
  @idle_shutdown_config = args[:idle_shutdown_config] if args.key?(:idle_shutdown_config)
  @is_default = args[:is_default] if args.key?(:is_default)
  @labels = args[:labels] if args.key?(:labels)
  @machine_spec = args[:machine_spec] if args.key?(:machine_spec)
  @name = args[:name] if args.key?(:name)
  @network_spec = args[:network_spec] if args.key?(:network_spec)
  @network_tags = args[:network_tags] if args.key?(:network_tags)
  @notebook_runtime_type = args[:notebook_runtime_type] if args.key?(:notebook_runtime_type)
  @reservation_affinity = args[:reservation_affinity] if args.key?(:reservation_affinity)
  @service_account = args[:service_account] if args.key?(:service_account)
  @shielded_vm_config = args[:shielded_vm_config] if args.key?(:shielded_vm_config)
  @software_config = args[:software_config] if args.key?(:software_config)
  @update_time = args[:update_time] if args.key?(:update_time)
end