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.



20715
20716
20717
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20715

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) 


20547
20548
20549
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20547

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:



20552
20553
20554
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20552

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) 


20557
20558
20559
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20557

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) 


20563
20564
20565
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20563

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:



20569
20570
20571
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20569

def encryption_spec
  @encryption_spec
end

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

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

Returns:



20574
20575
20576
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20574

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) 


20583
20584
20585
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20583

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) 


20588
20589
20590
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20588

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:



20594
20595
20596
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20594

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) 


20599
20600
20601
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20599

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


20617
20618
20619
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20617

def labels
  @labels
end

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

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

Returns:



20622
20623
20624
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20622

def machine_spec
  @machine_spec
end

#name ⇒ String

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

Returns:

  • (String) 


20627
20628
20629
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20627

def name
  @name
end

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

Network spec. Corresponds to the JSON property networkSpec

Returns:



20632
20633
20634
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20632

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


20638
20639
20640
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20638

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:



20643
20644
20645
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20643

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) 


20648
20649
20650
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20648

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) 


20653
20654
20655
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20653

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:



20658
20659
20660
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20658

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) 


20663
20664
20665
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20663

def runtime_state
  @runtime_state
end

#runtime_user ⇒ String

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

Returns:

  • (String) 


20668
20669
20670
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20668

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) 


20673
20674
20675
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20673

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) 


20679
20680
20681
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20679

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) 


20690
20691
20692
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20690

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:



20697
20698
20699
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20697

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:



20703
20704
20705
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20703

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) 


20708
20709
20710
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20708

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) 


20713
20714
20715
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20713

def version
  @version
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



20720
20721
20722
20723
20724
20725
20726
20727
20728
20729
20730
20731
20732
20733
20734
20735
20736
20737
20738
20739
20740
20741
20742
20743
20744
20745
20746
20747
20748
20749
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20720

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