Class: Google::Apis::NotebooksV2::Instance

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/notebooks_v2/classes.rb,
lib/google/apis/notebooks_v2/representations.rb,
lib/google/apis/notebooks_v2/representations.rb

Overview

The definition of a notebook instance.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Instance

Returns a new instance of Instance.



697
698
699
 
# File 'lib/google/apis/notebooks_v2/classes.rb', line 697

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#create_time ⇒ String

Output only. Instance creation time. Corresponds to the JSON property createTime

Returns:

  • (String) 


620
621
622
 
# File 'lib/google/apis/notebooks_v2/classes.rb', line 620

def create_time
  @create_time
end

#creator ⇒ String

Output only. Email address of entity that sent original CreateInstance request. Corresponds to the JSON property creator

Returns:

  • (String) 


625
626
627
 
# File 'lib/google/apis/notebooks_v2/classes.rb', line 625

def creator
  @creator
end

#disable_proxy_access ⇒ Boolean Also known as: disable_proxy_access?

Optional. If true, the notebook instance will not register with the proxy. Corresponds to the JSON property disableProxyAccess

Returns:

  • (Boolean) 


630
631
632
 
# File 'lib/google/apis/notebooks_v2/classes.rb', line 630

def disable_proxy_access
  @disable_proxy_access
end

#gce_setup ⇒ Google::Apis::NotebooksV2::GceSetup

The definition of how to configure a VM instance outside of Resources and Identity. Corresponds to the JSON property gceSetup

Returns:



637
638
639
 
# File 'lib/google/apis/notebooks_v2/classes.rb', line 637

def gce_setup
  @gce_setup
end

#health_info ⇒ Hash<String,String>

Output only. Additional information about instance health. Example: healthInfo" : "docker_proxy_agent_status": "1", "docker_status": "1", " jupyterlab_api_status": "-1", "jupyterlab_status": "-1", "updated": "2020-10- 18 09:40:03.573409" Corresponds to the JSON property healthInfo

Returns:

  • (Hash<String,String>) 


645
646
647
 
# File 'lib/google/apis/notebooks_v2/classes.rb', line 645

def health_info
  @health_info
end

#health_state ⇒ String

Output only. Instance health_state. Corresponds to the JSON property healthState

Returns:

  • (String) 


650
651
652
 
# File 'lib/google/apis/notebooks_v2/classes.rb', line 650

def health_state
  @health_state
end

#id ⇒ String

Output only. Unique ID of the resource. Corresponds to the JSON property id

Returns:

  • (String) 


655
656
657
 
# File 'lib/google/apis/notebooks_v2/classes.rb', line 655

def id
  @id
end

#instance_owners ⇒ Array<String>

Optional. Input only. The owner of this instance after creation. Format: alias@example.com Currently supports one owner only. If not specified, all of the service account users of your VM instance's service account can use the instance. Corresponds to the JSON property instanceOwners

Returns:

  • (Array<String>) 


663
664
665
 
# File 'lib/google/apis/notebooks_v2/classes.rb', line 663

def instance_owners
  @instance_owners
end

#labels ⇒ Hash<String,String>

Optional. Labels to apply to this instance. These can be later modified by the UpdateInstance method. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


669
670
671
 
# File 'lib/google/apis/notebooks_v2/classes.rb', line 669

def labels
  @labels
end

#name ⇒ String

Output only. The name of this notebook instance. Format: projects/project_id /locations/location/instances/instance_id` Corresponds to the JSON propertyname`

Returns:

  • (String) 


675
676
677
 
# File 'lib/google/apis/notebooks_v2/classes.rb', line 675

def name
  @name
end

#proxy_uri ⇒ String

Output only. The proxy endpoint that is used to access the Jupyter notebook. Corresponds to the JSON property proxyUri

Returns:

  • (String) 


680
681
682
 
# File 'lib/google/apis/notebooks_v2/classes.rb', line 680

def proxy_uri
  @proxy_uri
end

#state ⇒ String

Output only. The state of this instance. Corresponds to the JSON property state

Returns:

  • (String) 


685
686
687
 
# File 'lib/google/apis/notebooks_v2/classes.rb', line 685

def state
  @state
end

#update_time ⇒ String

Output only. Instance update time. Corresponds to the JSON property updateTime

Returns:

  • (String) 


690
691
692
 
# File 'lib/google/apis/notebooks_v2/classes.rb', line 690

def update_time
  @update_time
end

#upgrade_history ⇒ Array<Google::Apis::NotebooksV2::UpgradeHistoryEntry>

Output only. The upgrade history of this instance. Corresponds to the JSON property upgradeHistory

Returns:



695
696
697
 
# File 'lib/google/apis/notebooks_v2/classes.rb', line 695

def upgrade_history
  @upgrade_history
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
 
# File 'lib/google/apis/notebooks_v2/classes.rb', line 702

def update!(**args)
  @create_time = args[:create_time] if args.key?(:create_time)
  @creator = args[:creator] if args.key?(:creator)
  @disable_proxy_access = args[:disable_proxy_access] if args.key?(:disable_proxy_access)
  @gce_setup = args[:gce_setup] if args.key?(:gce_setup)
  @health_info = args[:health_info] if args.key?(:health_info)
  @health_state = args[:health_state] if args.key?(:health_state)
  @id = args[:id] if args.key?(:id)
  @instance_owners = args[:instance_owners] if args.key?(:instance_owners)
  @labels = args[:labels] if args.key?(:labels)
  @name = args[:name] if args.key?(:name)
  @proxy_uri = args[:proxy_uri] if args.key?(:proxy_uri)
  @state = args[:state] if args.key?(:state)
  @update_time = args[:update_time] if args.key?(:update_time)
  @upgrade_history = args[:upgrade_history] if args.key?(:upgrade_history)
end