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.



26570
26571
26572
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 26570

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) 


26402
26403
26404
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 26402

def create_time
  @create_time
end

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

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

Returns:



26407
26408
26409
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 26407

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) 


26412
26413
26414
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 26412

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) 


26418
26419
26420
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 26418

def display_name
  @display_name
end

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

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

Returns:



26424
26425
26426
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 26424

def encryption_spec
  @encryption_spec
end

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

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

Returns:



26429
26430
26431
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 26429

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) 


26438
26439
26440
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 26438

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) 


26443
26444
26445
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 26443

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:



26449
26450
26451
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 26449

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) 


26454
26455
26456
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 26454

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


26472
26473
26474
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 26472

def labels
  @labels
end

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

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

Returns:



26477
26478
26479
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 26477

def machine_spec
  @machine_spec
end

#name ⇒ String

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

Returns:

  • (String) 


26482
26483
26484
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 26482

def name
  @name
end

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

Network spec. Corresponds to the JSON property networkSpec

Returns:



26487
26488
26489
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 26487

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


26493
26494
26495
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 26493

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:



26498
26499
26500
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 26498

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) 


26503
26504
26505
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 26503

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) 


26508
26509
26510
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 26508

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:



26513
26514
26515
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 26513

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) 


26518
26519
26520
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 26518

def runtime_state
  @runtime_state
end

#runtime_user ⇒ String

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

Returns:

  • (String) 


26523
26524
26525
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 26523

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) 


26528
26529
26530
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 26528

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) 


26534
26535
26536
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 26534

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) 


26545
26546
26547
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 26545

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:



26552
26553
26554
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 26552

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:



26558
26559
26560
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 26558

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) 


26563
26564
26565
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 26563

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) 


26568
26569
26570
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 26568

def version
  @version
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



26575
26576
26577
26578
26579
26580
26581
26582
26583
26584
26585
26586
26587
26588
26589
26590
26591
26592
26593
26594
26595
26596
26597
26598
26599
26600
26601
26602
26603
26604
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 26575

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