Reference documentation and code samples for the AI Platform Notebooks V1 API module Google::Cloud::Notebooks::V1::GetInstanceHealthResponse::HealthState.
If an instance is healthy or not.
Constants
HEALTH_STATE_UNSPECIFIED
value: 0 The instance substate is unknown.
HEALTHY
value: 1 The instance is known to be in an healthy state
(for example, critical daemons are running)
Applies to ACTIVE state.
UNHEALTHY
value: 2 The instance is known to be in an unhealthy state
(for example, critical daemons are not running)
Applies to ACTIVE state.
AGENT_NOT_INSTALLED
value: 3 The instance has not installed health monitoring agent.
Applies to ACTIVE state.
AGENT_NOT_RUNNING
value: 4 The instance health monitoring agent is not running.
Applies to ACTIVE state.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-28 UTC."],[],[],null,["# AI Platform Notebooks V1 API - Module Google::Cloud::Notebooks::V1::GetInstanceHealthResponse::HealthState (v1.1.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.1.0 (latest)](/ruby/docs/reference/google-cloud-notebooks-v1/latest/Google-Cloud-Notebooks-V1-GetInstanceHealthResponse-HealthState)\n- [1.0.1](/ruby/docs/reference/google-cloud-notebooks-v1/1.0.1/Google-Cloud-Notebooks-V1-GetInstanceHealthResponse-HealthState)\n- [0.11.0](/ruby/docs/reference/google-cloud-notebooks-v1/0.11.0/Google-Cloud-Notebooks-V1-GetInstanceHealthResponse-HealthState)\n- [0.10.0](/ruby/docs/reference/google-cloud-notebooks-v1/0.10.0/Google-Cloud-Notebooks-V1-GetInstanceHealthResponse-HealthState)\n- [0.9.1](/ruby/docs/reference/google-cloud-notebooks-v1/0.9.1/Google-Cloud-Notebooks-V1-GetInstanceHealthResponse-HealthState)\n- [0.8.2](/ruby/docs/reference/google-cloud-notebooks-v1/0.8.2/Google-Cloud-Notebooks-V1-GetInstanceHealthResponse-HealthState)\n- [0.7.0](/ruby/docs/reference/google-cloud-notebooks-v1/0.7.0/Google-Cloud-Notebooks-V1-GetInstanceHealthResponse-HealthState)\n- [0.6.1](/ruby/docs/reference/google-cloud-notebooks-v1/0.6.1/Google-Cloud-Notebooks-V1-GetInstanceHealthResponse-HealthState)\n- [0.5.0](/ruby/docs/reference/google-cloud-notebooks-v1/0.5.0/Google-Cloud-Notebooks-V1-GetInstanceHealthResponse-HealthState)\n- [0.4.2](/ruby/docs/reference/google-cloud-notebooks-v1/0.4.2/Google-Cloud-Notebooks-V1-GetInstanceHealthResponse-HealthState)\n- [0.3.0](/ruby/docs/reference/google-cloud-notebooks-v1/0.3.0/Google-Cloud-Notebooks-V1-GetInstanceHealthResponse-HealthState)\n- [0.2.1](/ruby/docs/reference/google-cloud-notebooks-v1/0.2.1/Google-Cloud-Notebooks-V1-GetInstanceHealthResponse-HealthState)\n- [0.1.0](/ruby/docs/reference/google-cloud-notebooks-v1/0.1.0/Google-Cloud-Notebooks-V1-GetInstanceHealthResponse-HealthState) \nReference documentation and code samples for the AI Platform Notebooks V1 API module Google::Cloud::Notebooks::V1::GetInstanceHealthResponse::HealthState.\n\nIf an instance is healthy or not.\n\nConstants\n---------\n\n### HEALTH_STATE_UNSPECIFIED\n\n**value:** 0 \nThe instance substate is unknown.\n\n### HEALTHY\n\n**value:** 1 \nThe instance is known to be in an healthy state\n(for example, critical daemons are running)\nApplies to ACTIVE state.\n\n### UNHEALTHY\n\n**value:** 2 \nThe instance is known to be in an unhealthy state\n(for example, critical daemons are not running)\nApplies to ACTIVE state.\n\n### AGENT_NOT_INSTALLED\n\n**value:** 3 \nThe instance has not installed health monitoring agent.\nApplies to ACTIVE state.\n\n### AGENT_NOT_RUNNING\n\n**value:** 4 \nThe instance health monitoring agent is not running.\nApplies to ACTIVE state."]]
