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.



15928
15929
15930
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 15928

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) 


15825
15826
15827
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 15825

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:



15830
15831
15832
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 15830

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) 


15835
15836
15837
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 15835

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) 


15841
15842
15843
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 15841

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) 


15847
15848
15849
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 15847

def etag
  @etag
end

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

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

Returns:



15852
15853
15854
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 15852

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:



15858
15859
15860
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 15858

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) 


15863
15864
15865
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 15863

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


15873
15874
15875
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 15873

def labels
  @labels
end

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

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

Returns:



15878
15879
15880
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 15878

def machine_spec
  @machine_spec
end

#name ⇒ String

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

Returns:

  • (String) 


15883
15884
15885
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 15883

def name
  @name
end

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

Network spec. Corresponds to the JSON property networkSpec

Returns:



15888
15889
15890
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 15888

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


15894
15895
15896
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 15894

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) 


15899
15900
15901
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 15899

def notebook_runtime_type
  @notebook_runtime_type
end

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

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

Returns:



15904
15905
15906
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 15904

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


15913
15914
15915
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 15913

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:



15920
15921
15922
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 15920

def shielded_vm_config
  @shielded_vm_config
end

#update_time ⇒ String

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

Returns:

  • (String) 


15926
15927
15928
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 15926

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



15933
15934
15935
15936
15937
15938
15939
15940
15941
15942
15943
15944
15945
15946
15947
15948
15949
15950
15951
15952
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 15933

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