Class: Google::Apis::AiplatformV1::GoogleCloudAiplatformV1NotebookRuntimeTemplate

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/aiplatform_v1/classes.rb,
lib/google/apis/aiplatform_v1/representations.rb,
lib/google/apis/aiplatform_v1/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) ⇒ GoogleCloudAiplatformV1NotebookRuntimeTemplate

Returns a new instance of GoogleCloudAiplatformV1NotebookRuntimeTemplate.



21213
21214
21215
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 21213

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) 


21092
21093
21094
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 21092

def create_time
  @create_time
end

#data_persistent_disk_spec ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1PersistentDiskSpec

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

Returns:



21097
21098
21099
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 21097

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) 


21102
21103
21104
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 21102

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) 


21108
21109
21110
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 21108

def display_name
  @display_name
end

#encryption_spec ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EncryptionSpec

Represents a customer-managed encryption key spec that can be applied to a top- level resource. Corresponds to the JSON property encryptionSpec

Returns:



21114
21115
21116
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 21114

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) 


21120
21121
21122
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 21120

def etag
  @etag
end

#euc_config ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1NotebookEucConfig

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

Returns:



21125
21126
21127
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 21125

def euc_config
  @euc_config
end

#idle_shutdown_config ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1NotebookIdleShutdownConfig

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

Returns:



21131
21132
21133
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 21131

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) 


21137
21138
21139
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 21137

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


21147
21148
21149
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 21147

def labels
  @labels
end

#machine_spec ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1MachineSpec

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

Returns:



21152
21153
21154
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 21152

def machine_spec
  @machine_spec
end

#name ⇒ String

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

Returns:

  • (String) 


21157
21158
21159
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 21157

def name
  @name
end

#network_spec ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1NetworkSpec

Network spec. Corresponds to the JSON property networkSpec

Returns:



21162
21163
21164
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 21162

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


21168
21169
21170
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 21168

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) 


21173
21174
21175
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 21173

def notebook_runtime_type
  @notebook_runtime_type
end

#reservation_affinity ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1NotebookReservationAffinity

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

Returns:



21178
21179
21180
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 21178

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) 


21192
21193
21194
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 21192

def 
  @service_account
end

#shielded_vm_config ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ShieldedVmConfig

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

Returns:



21199
21200
21201
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 21199

def shielded_vm_config
  @shielded_vm_config
end

#software_config ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1NotebookSoftwareConfig

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

Returns:



21205
21206
21207
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 21205

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) 


21211
21212
21213
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 21211

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



21218
21219
21220
21221
21222
21223
21224
21225
21226
21227
21228
21229
21230
21231
21232
21233
21234
21235
21236
21237
21238
21239
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 21218

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