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.



12361
12362
12363
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 12361

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) 


12276
12277
12278
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 12276

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:



12281
12282
12283
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 12281

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) 


12286
12287
12288
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 12286

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) 


12292
12293
12294
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 12292

def display_name
  @display_name
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) 


12298
12299
12300
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 12298

def etag
  @etag
end

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

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

Returns:



12303
12304
12305
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 12303

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:



12309
12310
12311
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 12309

def idle_shutdown_config
  @idle_shutdown_config
end

#is_default ⇒ Boolean Also known as: is_default?

Output only. The default template to use if not specified. Corresponds to the JSON property isDefault

Returns:

  • (Boolean) 


12314
12315
12316
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 12314

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


12324
12325
12326
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 12324

def labels
  @labels
end

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

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

Returns:



12329
12330
12331
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 12329

def machine_spec
  @machine_spec
end

#name ⇒ String

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

Returns:

  • (String) 


12334
12335
12336
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 12334

def name
  @name
end

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

Network spec. Corresponds to the JSON property networkSpec

Returns:



12339
12340
12341
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 12339

def network_spec
  @network_spec
end

#notebook_runtime_type ⇒ String

Optional. Immutable. The type of the notebook runtime template. Corresponds to the JSON property notebookRuntimeType

Returns:

  • (String) 


12344
12345
12346
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 12344

def notebook_runtime_type
  @notebook_runtime_type
end

#service_account ⇒ String

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) 


12353
12354
12355
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 12353

def 
  @service_account
end

#update_time ⇒ String

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

Returns:

  • (String) 


12359
12360
12361
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 12359

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



12366
12367
12368
12369
12370
12371
12372
12373
12374
12375
12376
12377
12378
12379
12380
12381
12382
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 12366

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)
  @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)
  @notebook_runtime_type = args[:notebook_runtime_type] if args.key?(:notebook_runtime_type)
  @service_account = args[:service_account] if args.key?(:service_account)
  @update_time = args[:update_time] if args.key?(:update_time)
end