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.



860
861
862
 
# File 'lib/google/apis/notebooks_v2/classes.rb', line 860

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) 


758
759
760
 
# File 'lib/google/apis/notebooks_v2/classes.rb', line 758

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) 


763
764
765
 
# File 'lib/google/apis/notebooks_v2/classes.rb', line 763

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) 


768
769
770
 
# File 'lib/google/apis/notebooks_v2/classes.rb', line 768

def disable_proxy_access
  @disable_proxy_access
end

#enable_third_party_identity ⇒ Boolean Also known as: enable_third_party_identity?

Optional. Flag that specifies that a notebook can be accessed with third party identity provider. Corresponds to the JSON property enableThirdPartyIdentity

Returns:

  • (Boolean) 


775
776
777
 
# File 'lib/google/apis/notebooks_v2/classes.rb', line 775

def enable_third_party_identity
  @enable_third_party_identity
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:



782
783
784
 
# File 'lib/google/apis/notebooks_v2/classes.rb', line 782

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


790
791
792
 
# File 'lib/google/apis/notebooks_v2/classes.rb', line 790

def health_info
  @health_info
end

#health_state ⇒ String

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

Returns:

  • (String) 


795
796
797
 
# File 'lib/google/apis/notebooks_v2/classes.rb', line 795

def health_state
  @health_state
end

#id ⇒ String

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

Returns:

  • (String) 


800
801
802
 
# File 'lib/google/apis/notebooks_v2/classes.rb', line 800

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


808
809
810
 
# File 'lib/google/apis/notebooks_v2/classes.rb', line 808

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


814
815
816
 
# File 'lib/google/apis/notebooks_v2/classes.rb', line 814

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) 


820
821
822
 
# File 'lib/google/apis/notebooks_v2/classes.rb', line 820

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) 


825
826
827
 
# File 'lib/google/apis/notebooks_v2/classes.rb', line 825

def proxy_uri
  @proxy_uri
end

#satisfies_pzi ⇒ Boolean Also known as: satisfies_pzi?

Output only. Reserved for future use for Zone Isolation. Corresponds to the JSON property satisfiesPzi

Returns:

  • (Boolean) 


830
831
832
 
# File 'lib/google/apis/notebooks_v2/classes.rb', line 830

def satisfies_pzi
  @satisfies_pzi
end

#satisfies_pzs ⇒ Boolean Also known as: satisfies_pzs?

Output only. Reserved for future use for Zone Separation. Corresponds to the JSON property satisfiesPzs

Returns:

  • (Boolean) 


836
837
838
 
# File 'lib/google/apis/notebooks_v2/classes.rb', line 836

def satisfies_pzs
  @satisfies_pzs
end

#state ⇒ String

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

Returns:

  • (String) 


842
843
844
 
# File 'lib/google/apis/notebooks_v2/classes.rb', line 842

def state
  @state
end

#third_party_proxy_url ⇒ String

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

Returns:

  • (String) 


848
849
850
 
# File 'lib/google/apis/notebooks_v2/classes.rb', line 848

def third_party_proxy_url
  @third_party_proxy_url
end

#update_time ⇒ String

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

Returns:

  • (String) 


853
854
855
 
# File 'lib/google/apis/notebooks_v2/classes.rb', line 853

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:



858
859
860
 
# File 'lib/google/apis/notebooks_v2/classes.rb', line 858

def upgrade_history
  @upgrade_history
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
 
# File 'lib/google/apis/notebooks_v2/classes.rb', line 865

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)
  @enable_third_party_identity = args[:enable_third_party_identity] if args.key?(:enable_third_party_identity)
  @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)
  @satisfies_pzi = args[:satisfies_pzi] if args.key?(:satisfies_pzi)
  @satisfies_pzs = args[:satisfies_pzs] if args.key?(:satisfies_pzs)
  @state = args[:state] if args.key?(:state)
  @third_party_proxy_url = args[:third_party_proxy_url] if args.key?(:third_party_proxy_url)
  @update_time = args[:update_time] if args.key?(:update_time)
  @upgrade_history = args[:upgrade_history] if args.key?(:upgrade_history)
end