Reference documentation and code samples for the Cloud OS Config V1 API module Google::Cloud::OsConfig::V1::Instance::PatchState.
Patch state of an instance.
Constants
PATCH_STATE_UNSPECIFIED
value: 0 Unspecified.
PENDING
value: 1 The instance is not yet notified.
INACTIVE
value: 2 Instance is inactive and cannot be patched.
NOTIFIED
value: 3 The instance is notified that it should be patched.
STARTED
value: 4 The instance has started the patching process.
DOWNLOADING_PATCHES
value: 5 The instance is downloading patches.
APPLYING_PATCHES
value: 6 The instance is applying patches.
REBOOTING
value: 7 The instance is rebooting.
SUCCEEDED
value: 8 The instance has completed applying patches.
SUCCEEDED_REBOOT_REQUIRED
value: 9 The instance has completed applying patches but a reboot is required.
FAILED
value: 10 The instance has failed to apply the patch.
ACKED
value: 11 The instance acked the notification and will start shortly.
TIMED_OUT
value: 12 The instance exceeded the time out while applying the patch.
RUNNING_PRE_PATCH_STEP
value: 13 The instance is running the pre-patch step.
RUNNING_POST_PATCH_STEP
value: 14 The instance is running the post-patch step.
NO_AGENT_DETECTED
value: 15 The service could not detect the presence of the agent. Check to ensure
that the agent is installed, running, and able to communicate with the
service.
[[["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-09-09 UTC."],[],[],null,["# Cloud OS Config V1 API - Module Google::Cloud::OsConfig::V1::Instance::PatchState (v1.4.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.4.0 (latest)](/ruby/docs/reference/google-cloud-os_config-v1/latest/Google-Cloud-OsConfig-V1-Instance-PatchState)\n- [1.3.0](/ruby/docs/reference/google-cloud-os_config-v1/1.3.0/Google-Cloud-OsConfig-V1-Instance-PatchState)\n- [1.2.1](/ruby/docs/reference/google-cloud-os_config-v1/1.2.1/Google-Cloud-OsConfig-V1-Instance-PatchState)\n- [1.1.0](/ruby/docs/reference/google-cloud-os_config-v1/1.1.0/Google-Cloud-OsConfig-V1-Instance-PatchState)\n- [1.0.1](/ruby/docs/reference/google-cloud-os_config-v1/1.0.1/Google-Cloud-OsConfig-V1-Instance-PatchState)\n- [0.16.0](/ruby/docs/reference/google-cloud-os_config-v1/0.16.0/Google-Cloud-OsConfig-V1-Instance-PatchState)\n- [0.15.2](/ruby/docs/reference/google-cloud-os_config-v1/0.15.2/Google-Cloud-OsConfig-V1-Instance-PatchState)\n- [0.14.0](/ruby/docs/reference/google-cloud-os_config-v1/0.14.0/Google-Cloud-OsConfig-V1-Instance-PatchState)\n- [0.13.0](/ruby/docs/reference/google-cloud-os_config-v1/0.13.0/Google-Cloud-OsConfig-V1-Instance-PatchState)\n- [0.12.0](/ruby/docs/reference/google-cloud-os_config-v1/0.12.0/Google-Cloud-OsConfig-V1-Instance-PatchState)\n- [0.11.0](/ruby/docs/reference/google-cloud-os_config-v1/0.11.0/Google-Cloud-OsConfig-V1-Instance-PatchState)\n- [0.10.0](/ruby/docs/reference/google-cloud-os_config-v1/0.10.0/Google-Cloud-OsConfig-V1-Instance-PatchState)\n- [0.9.1](/ruby/docs/reference/google-cloud-os_config-v1/0.9.1/Google-Cloud-OsConfig-V1-Instance-PatchState) \nReference documentation and code samples for the Cloud OS Config V1 API module Google::Cloud::OsConfig::V1::Instance::PatchState.\n\nPatch state of an instance.\n\nConstants\n---------\n\n### PATCH_STATE_UNSPECIFIED\n\n**value:** 0 \nUnspecified.\n\n### PENDING\n\n**value:** 1 \nThe instance is not yet notified.\n\n### INACTIVE\n\n**value:** 2 \nInstance is inactive and cannot be patched.\n\n### NOTIFIED\n\n**value:** 3 \nThe instance is notified that it should be patched.\n\n### STARTED\n\n**value:** 4 \nThe instance has started the patching process.\n\n### DOWNLOADING_PATCHES\n\n**value:** 5 \nThe instance is downloading patches.\n\n### APPLYING_PATCHES\n\n**value:** 6 \nThe instance is applying patches.\n\n### REBOOTING\n\n**value:** 7 \nThe instance is rebooting.\n\n### SUCCEEDED\n\n**value:** 8 \nThe instance has completed applying patches.\n\n### SUCCEEDED_REBOOT_REQUIRED\n\n**value:** 9 \nThe instance has completed applying patches but a reboot is required.\n\n### FAILED\n\n**value:** 10 \nThe instance has failed to apply the patch.\n\n### ACKED\n\n**value:** 11 \nThe instance acked the notification and will start shortly.\n\n### TIMED_OUT\n\n**value:** 12 \nThe instance exceeded the time out while applying the patch.\n\n### RUNNING_PRE_PATCH_STEP\n\n**value:** 13 \nThe instance is running the pre-patch step.\n\n### RUNNING_POST_PATCH_STEP\n\n**value:** 14 \nThe instance is running the post-patch step.\n\n### NO_AGENT_DETECTED\n\n**value:** 15 \nThe service could not detect the presence of the agent. Check to ensure\nthat the agent is installed, running, and able to communicate with the\nservice."]]