Notebooks V2 API - Class Google::Cloud::Notebooks::V2::Instance (v0.5.0)

Reference documentation and code samples for the Notebooks V2 API class Google::Cloud::Notebooks::V2::Instance.

The definition of a notebook instance.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#create_time

def create_time() -> ::Google::Protobuf::Timestamp
Returns

#creator

def creator() -> ::String
Returns
  • (::String) — Output only. Email address of entity that sent original CreateInstance request.

#disable_proxy_access

def disable_proxy_access() -> ::Boolean
Returns
  • (::Boolean) — Optional. If true, the notebook instance will not register with the proxy.

#disable_proxy_access=

def disable_proxy_access=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Optional. If true, the notebook instance will not register with the proxy.
Returns
  • (::Boolean) — Optional. If true, the notebook instance will not register with the proxy.

#gce_setup

def gce_setup() -> ::Google::Cloud::Notebooks::V2::GceSetup
Returns

#gce_setup=

def gce_setup=(value) -> ::Google::Cloud::Notebooks::V2::GceSetup
Parameter
Returns

#health_info

def health_info() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::Google::Protobuf::Map{::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"
}

#health_state

def health_state() -> ::Google::Cloud::Notebooks::V2::HealthState
Returns

#id

def id() -> ::String
Returns
  • (::String) — Output only. Unique ID of the resource.

#instance_owners

def instance_owners() -> ::Array<::String>
Returns
  • (::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.

#instance_owners=

def instance_owners=(value) -> ::Array<::String>
Parameter
  • value (::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.

Returns
  • (::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.

#labels

def labels() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Optional. Labels to apply to this instance. These can be later modified by the UpdateInstance method.

#labels=

def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::Google::Protobuf::Map{::String => ::String}) — Optional. Labels to apply to this instance. These can be later modified by the UpdateInstance method.
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Optional. Labels to apply to this instance. These can be later modified by the UpdateInstance method.

#name

def name() -> ::String
Returns
  • (::String) — Output only. The name of this notebook instance. Format: projects/{project_id}/locations/{location}/instances/{instance_id}

#proxy_uri

def proxy_uri() -> ::String
Returns
  • (::String) — Output only. The proxy endpoint that is used to access the Jupyter notebook.

#state

def state() -> ::Google::Cloud::Notebooks::V2::State
Returns

#update_time

def update_time() -> ::Google::Protobuf::Timestamp
Returns

#upgrade_history

def upgrade_history() -> ::Array<::Google::Cloud::Notebooks::V2::UpgradeHistoryEntry>
Returns