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.



40496
40497
40498
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 40496

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) 


40375
40376
40377
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 40375

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:



40380
40381
40382
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 40380

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) 


40385
40386
40387
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 40385

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) 


40391
40392
40393
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 40391

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:



40397
40398
40399
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 40397

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) 


40403
40404
40405
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 40403

def etag
  @etag
end

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

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

Returns:



40408
40409
40410
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 40408

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:



40414
40415
40416
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 40414

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) 


40420
40421
40422
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 40420

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


40430
40431
40432
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 40430

def labels
  @labels
end

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

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

Returns:



40435
40436
40437
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 40435

def machine_spec
  @machine_spec
end

#name ⇒ String

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

Returns:

  • (String) 


40440
40441
40442
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 40440

def name
  @name
end

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

Network spec. Corresponds to the JSON property networkSpec

Returns:



40445
40446
40447
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 40445

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


40451
40452
40453
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 40451

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) 


40456
40457
40458
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 40456

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:



40461
40462
40463
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 40461

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) 


40475
40476
40477
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 40475

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:



40482
40483
40484
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 40482

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:



40488
40489
40490
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 40488

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) 


40494
40495
40496
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 40494

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



40501
40502
40503
40504
40505
40506
40507
40508
40509
40510
40511
40512
40513
40514
40515
40516
40517
40518
40519
40520
40521
40522
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 40501

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