Class: Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1NotebookRuntime

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 runtime is a virtual machine allocated to a particular user for a particular Notebook file on temporary basis with lifetime limited to 24 hours.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudAiplatformV1beta1NotebookRuntime

Returns a new instance of GoogleCloudAiplatformV1beta1NotebookRuntime.



12673
12674
12675
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 12673

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) 


12606
12607
12608
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 12606

def create_time
  @create_time
end

#description ⇒ String

The description of the NotebookRuntime. Corresponds to the JSON property description

Returns:

  • (String) 


12611
12612
12613
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 12611

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) 


12617
12618
12619
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 12617

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


12626
12627
12628
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 12626

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) 


12631
12632
12633
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 12631

def health_state
  @health_state
end

#name ⇒ String

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

Returns:

  • (String) 


12636
12637
12638
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 12636

def name
  @name
end

#notebook_runtime_template_ref ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1NotebookRuntimeTemplateRef

Points to a NotebookRuntimeTemplateRef. Corresponds to the JSON property notebookRuntimeTemplateRef

Returns:



12641
12642
12643
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 12641

def notebook_runtime_template_ref
  @notebook_runtime_template_ref
end

#proxy_uri ⇒ String

Output only. The proxy endpoint used to access the NotebookRuntime. Corresponds to the JSON property proxyUri

Returns:

  • (String) 


12646
12647
12648
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 12646

def proxy_uri
  @proxy_uri
end

#runtime_state ⇒ String

Output only. The runtime (instance) state of the NotebookRuntime. Corresponds to the JSON property runtimeState

Returns:

  • (String) 


12651
12652
12653
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 12651

def runtime_state
  @runtime_state
end

#runtime_user ⇒ String

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

Returns:

  • (String) 


12656
12657
12658
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 12656

def runtime_user
  @runtime_user
end

#service_account ⇒ String

Output only. The service account that the NotebookRuntime workload runs as. Corresponds to the JSON property serviceAccount

Returns:

  • (String) 


12661
12662
12663
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 12661

def 
  @service_account
end

#update_time ⇒ String

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

Returns:

  • (String) 


12666
12667
12668
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 12666

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) 


12671
12672
12673
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 12671

def version
  @version
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



12678
12679
12680
12681
12682
12683
12684
12685
12686
12687
12688
12689
12690
12691
12692
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 12678

def update!(**args)
  @create_time = args[:create_time] if args.key?(:create_time)
  @description = args[:description] if args.key?(:description)
  @display_name = args[:display_name] if args.key?(:display_name)
  @expiration_time = args[:expiration_time] if args.key?(:expiration_time)
  @health_state = args[:health_state] if args.key?(:health_state)
  @name = args[:name] if args.key?(:name)
  @notebook_runtime_template_ref = args[:notebook_runtime_template_ref] if args.key?(:notebook_runtime_template_ref)
  @proxy_uri = args[:proxy_uri] if args.key?(:proxy_uri)
  @runtime_state = args[:runtime_state] if args.key?(:runtime_state)
  @runtime_user = args[:runtime_user] if args.key?(:runtime_user)
  @service_account = args[:service_account] if args.key?(:service_account)
  @update_time = args[:update_time] if args.key?(:update_time)
  @version = args[:version] if args.key?(:version)
end