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.



13934
13935
13936
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 13934

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) 


13845
13846
13847
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 13845

def create_time
  @create_time
end

#description ⇒ String

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

Returns:

  • (String) 


13850
13851
13852
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 13850

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) 


13856
13857
13858
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 13856

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) 


13865
13866
13867
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 13865

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) 


13870
13871
13872
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 13870

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


13887
13888
13889
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 13887

def labels
  @labels
end

#name ⇒ String

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

Returns:

  • (String) 


13892
13893
13894
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 13892

def name
  @name
end

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

Points to a NotebookRuntimeTemplateRef. Corresponds to the JSON property notebookRuntimeTemplateRef

Returns:



13897
13898
13899
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 13897

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) 


13902
13903
13904
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 13902

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) 


13907
13908
13909
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 13907

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) 


13912
13913
13914
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 13912

def runtime_state
  @runtime_state
end

#runtime_user ⇒ String

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

Returns:

  • (String) 


13917
13918
13919
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 13917

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) 


13922
13923
13924
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 13922

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) 


13927
13928
13929
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 13927

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) 


13932
13933
13934
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 13932

def version
  @version
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



13939
13940
13941
13942
13943
13944
13945
13946
13947
13948
13949
13950
13951
13952
13953
13954
13955
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 13939

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