Class: Google::Cloud::Notebooks::V1::GetInstanceHealthResponse

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/notebooks/v1/service.rb

Overview

Response for checking if a notebook instance is healthy.

Defined Under Namespace

Modules: HealthState Classes: HealthInfoEntry

Instance Attribute Summary collapse

Instance Attribute Details

#health_info ⇒ ::Google::Protobuf::Map{::String => ::String} (readonly)

Returns 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" }.

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" }



384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
 
# File 'proto_docs/google/cloud/notebooks/v1/service.rb', line 384

class GetInstanceHealthResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class HealthInfoEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # If an instance is healthy or not.
  module HealthState
    # The instance substate is unknown.
    HEALTH_STATE_UNSPECIFIED = 0

    # The instance is known to be in an healthy state
    # (for example, critical daemons are running)
    # Applies to ACTIVE state.
    HEALTHY = 1

    # The instance is known to be in an unhealthy state
    # (for example, critical daemons are not running)
    # Applies to ACTIVE state.
    UNHEALTHY = 2

    # The instance has not installed health monitoring agent.
    # Applies to ACTIVE state.
    AGENT_NOT_INSTALLED = 3

    # The instance health monitoring agent is not running.
    # Applies to ACTIVE state.
    AGENT_NOT_RUNNING = 4
  end
end

#health_state ⇒ ::Google::Cloud::Notebooks::V1::GetInstanceHealthResponse::HealthState (readonly)

Returns Output only. Runtime health_state.

Returns:



384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
 
# File 'proto_docs/google/cloud/notebooks/v1/service.rb', line 384

class GetInstanceHealthResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class HealthInfoEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # If an instance is healthy or not.
  module HealthState
    # The instance substate is unknown.
    HEALTH_STATE_UNSPECIFIED = 0

    # The instance is known to be in an healthy state
    # (for example, critical daemons are running)
    # Applies to ACTIVE state.
    HEALTHY = 1

    # The instance is known to be in an unhealthy state
    # (for example, critical daemons are not running)
    # Applies to ACTIVE state.
    UNHEALTHY = 2

    # The instance has not installed health monitoring agent.
    # Applies to ACTIVE state.
    AGENT_NOT_INSTALLED = 3

    # The instance health monitoring agent is not running.
    # Applies to ACTIVE state.
    AGENT_NOT_RUNNING = 4
  end
end