Reference documentation and code samples for the Cloud Shell v1 API enum StartEnvironmentMetadata.Types.State.
Possible states an environment might transition between during startup.
These states are not normally actionable by clients, but may be used to
show a progress message to the user. An environment won't necessarily go
through all of these states when starting. More states are likely to be
added in the future.
Startup is waiting for compute resources to be assigned to the
environment. This should normally happen very quickly, but an environment
might stay in this state for an extended period of time if the system is
experiencing heavy load.
Finished
Startup has completed. If the start operation was successful, the user
should be able to establish an SSH connection to their environment.
Otherwise, the operation will contain details of the failure.
Starting
The environment is in the process of being started, but no additional
details are available.
UnarchivingDisk
Startup is waiting for the user's disk to be unarchived. This can happen
when the user returns to Cloud Shell after not having used it for a
while, and suggests that startup will take longer than normal.
[[["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-03-21 UTC."],[[["This page details the `StartEnvironmentMetadata.Types.State` enum within the Google Cloud Shell v1 API, outlining the various states a Cloud Shell environment may experience during startup."],["The enum includes states like `AwaitingComputeResources`, `Finished`, `Starting`, `UnarchivingDisk`, and `Unspecified`, which reflect different stages and conditions of the environment initialization."],["The latest version of the API is 2.5.0, while this specific page is showing information for version 2.3.0."],["The listed fields (states) within the enum are not intended for direct client action, but are useful for understanding the environment's startup progress and potential issues."],["Each state field in the enum has a descriptive name and description regarding the environment's current status."]]],[]]
