Class: Google::Apis::AiplatformV1::GoogleCloudAiplatformV1NotebookRuntime

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 runtime is a virtual machine allocated to a particular user for a particular Notebook file on temporary basis with lifetime. Default runtimes have a lifetime of 18 hours, while custom runtimes last for 6 months from their creation or last upgrade.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudAiplatformV1NotebookRuntime

Returns a new instance of GoogleCloudAiplatformV1NotebookRuntime.



20315
20316
20317
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20315

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

Instance Attribute Details

#create_time ⇒ String

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

Returns:

  • (String) 


20147
20148
20149
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20147

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:



20152
20153
20154
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20152

def data_persistent_disk_spec
  @data_persistent_disk_spec
end

#description ⇒ String

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

Returns:

  • (String) 


20157
20158
20159
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20157

def description
  @description
end

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

Returns:

  • (String) 


20163
20164
20165
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20163

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:



20169
20170
20171
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20169

def encryption_spec
  @encryption_spec
end

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

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

Returns:



20174
20175
20176
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20174

def euc_config
  @euc_config
end

#expiration_time ⇒ String

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. Corresponds to the JSON property expirationTime

Returns:

  • (String) 


20183
20184
20185
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20183

def expiration_time
  @expiration_time
end

#health_state ⇒ String

Output only. The health state of the NotebookRuntime. Corresponds to the JSON property healthState

Returns:

  • (String) 


20188
20189
20190
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20188

def health_state
  @health_state
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:



20194
20195
20196
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20194

def idle_shutdown_config
  @idle_shutdown_config
end

#is_upgradable ⇒ Boolean Also known as: is_upgradable?

Output only. Whether NotebookRuntime is upgradable. Corresponds to the JSON property isUpgradable

Returns:

  • (Boolean) 


20199
20200
20201
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20199

def is_upgradable
  @is_upgradable
end

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

Returns:

  • (Hash<String,String>) 


20217
20218
20219
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20217

def labels
  @labels
end

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

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

Returns:



20222
20223
20224
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20222

def machine_spec
  @machine_spec
end

#name ⇒ String

Output only. The resource name of the NotebookRuntime. Corresponds to the JSON property name

Returns:

  • (String) 


20227
20228
20229
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20227

def name
  @name
end

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

Network spec. Corresponds to the JSON property networkSpec

Returns:



20232
20233
20234
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20232

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


20238
20239
20240
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20238

def network_tags
  @network_tags
end

#notebook_runtime_template_ref ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1NotebookRuntimeTemplateRef

Points to a NotebookRuntimeTemplateRef. Corresponds to the JSON property notebookRuntimeTemplateRef

Returns:



20243
20244
20245
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20243

def notebook_runtime_template_ref
  @notebook_runtime_template_ref
end

#notebook_runtime_type ⇒ String

Output only. The type of the notebook runtime. Corresponds to the JSON property notebookRuntimeType

Returns:

  • (String) 


20248
20249
20250
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20248

def notebook_runtime_type
  @notebook_runtime_type
end

#proxy_uri ⇒ String

Output only. The proxy endpoint used to access the NotebookRuntime. Corresponds to the JSON property proxyUri

Returns:

  • (String) 


20253
20254
20255
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20253

def proxy_uri
  @proxy_uri
end

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

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

Returns:



20258
20259
20260
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20258

def reservation_affinity
  @reservation_affinity
end

#runtime_state ⇒ String

Output only. The runtime (instance) state of the NotebookRuntime. Corresponds to the JSON property runtimeState

Returns:

  • (String) 


20263
20264
20265
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20263

def runtime_state
  @runtime_state
end

#runtime_user ⇒ String

Required. The user email of the NotebookRuntime. Corresponds to the JSON property runtimeUser

Returns:

  • (String) 


20268
20269
20270
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20268

def runtime_user
  @runtime_user
end

#satisfies_pzi ⇒ Boolean Also known as: satisfies_pzi?

Output only. Reserved for future use. Corresponds to the JSON property satisfiesPzi

Returns:

  • (Boolean) 


20273
20274
20275
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20273

def satisfies_pzi
  @satisfies_pzi
end

#satisfies_pzs ⇒ Boolean Also known as: satisfies_pzs?

Output only. Reserved for future use. Corresponds to the JSON property satisfiesPzs

Returns:

  • (Boolean) 


20279
20280
20281
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20279

def satisfies_pzs
  @satisfies_pzs
end

#service_account ⇒ String

Output only. Deprecated: This field is no longer used 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. The service account that the NotebookRuntime workload runs as. Corresponds to the JSON property serviceAccount

Returns:

  • (String) 


20290
20291
20292
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20290

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:



20297
20298
20299
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20297

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:



20303
20304
20305
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20303

def software_config
  @software_config
end

#update_time ⇒ String

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

Returns:

  • (String) 


20308
20309
20310
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20308

def update_time
  @update_time
end

#version ⇒ String

Output only. The VM os image version of NotebookRuntime. Corresponds to the JSON property version

Returns:

  • (String) 


20313
20314
20315
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20313

def version
  @version
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



20320
20321
20322
20323
20324
20325
20326
20327
20328
20329
20330
20331
20332
20333
20334
20335
20336
20337
20338
20339
20340
20341
20342
20343
20344
20345
20346
20347
20348
20349
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20320

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)
  @euc_config = args[:euc_config] if args.key?(:euc_config)
  @expiration_time = args[:expiration_time] if args.key?(:expiration_time)
  @health_state = args[:health_state] if args.key?(:health_state)
  @idle_shutdown_config = args[:idle_shutdown_config] if args.key?(:idle_shutdown_config)
  @is_upgradable = args[:is_upgradable] if args.key?(:is_upgradable)
  @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_template_ref = args[:notebook_runtime_template_ref] if args.key?(:notebook_runtime_template_ref)
  @notebook_runtime_type = args[:notebook_runtime_type] if args.key?(:notebook_runtime_type)
  @proxy_uri = args[:proxy_uri] if args.key?(:proxy_uri)
  @reservation_affinity = args[:reservation_affinity] if args.key?(:reservation_affinity)
  @runtime_state = args[:runtime_state] if args.key?(:runtime_state)
  @runtime_user = args[:runtime_user] if args.key?(:runtime_user)
  @satisfies_pzi = args[:satisfies_pzi] if args.key?(:satisfies_pzi)
  @satisfies_pzs = args[:satisfies_pzs] if args.key?(:satisfies_pzs)
  @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)
  @version = args[:version] if args.key?(:version)
end