Reference documentation and code samples for the Google Cloud Shell V1 Client class 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.
Google \ Cloud \ Shell \ V1 \ StartEnvironmentMetadata
Methods
static::name
Parameter
Name
Description
value
mixed
static::value
Parameter
Name
Description
name
mixed
Constants
STATE_UNSPECIFIED
Value: 0
The environment's start state is unknown.
Generated from protobuf enumSTATE_UNSPECIFIED = 0;
STARTING
Value: 1
The environment is in the process of being started, but no additional
details are available.
Generated from protobuf enumSTARTING = 1;
UNARCHIVING_DISK
Value: 2
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.
Generated from protobuf enumUNARCHIVING_DISK = 2;
AWAITING_COMPUTE_RESOURCES
Value: 4
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.
Generated from protobuf enumAWAITING_COMPUTE_RESOURCES = 4;
FINISHED
Value: 3
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.
[[["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-04 UTC."],[],[],null,["# Google Cloud Shell V1 Client - Class State (2.0.5)\n\nVersion latestkeyboard_arrow_down\n\n- [2.0.5 (latest)](/php/docs/reference/cloud-shell/latest/V1.StartEnvironmentMetadata.State)\n- [2.0.4](/php/docs/reference/cloud-shell/2.0.4/V1.StartEnvironmentMetadata.State)\n- [1.3.5](/php/docs/reference/cloud-shell/1.3.5/V1.StartEnvironmentMetadata.State)\n- [1.2.2](/php/docs/reference/cloud-shell/1.2.2/V1.StartEnvironmentMetadata.State)\n- [1.1.1](/php/docs/reference/cloud-shell/1.1.1/V1.StartEnvironmentMetadata.State)\n- [1.0.4](/php/docs/reference/cloud-shell/1.0.4/V1.StartEnvironmentMetadata.State) \nReference documentation and code samples for the Google Cloud Shell V1 Client class State.\n\nPossible states an environment might transition between during startup.\n\nThese states are not normally actionable by clients, but may be used to\nshow a progress message to the user. An environment won't necessarily go\nthrough all of these states when starting. More states are likely to be\nadded in the future.\n\nProtobuf type `google.cloud.shell.v1.StartEnvironmentMetadata.State`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Shell \\\\ V1 \\\\ StartEnvironmentMetadata\n\nMethods\n-------\n\n### static::name\n\n### static::value\n\nConstants\n---------\n\n### STATE_UNSPECIFIED\n\n Value: 0\n\nThe environment's start state is unknown.\n\nGenerated from protobuf enum `STATE_UNSPECIFIED = 0;`\n\n### STARTING\n\n Value: 1\n\nThe environment is in the process of being started, but no additional\ndetails are available.\n\nGenerated from protobuf enum `STARTING = 1;`\n\n### UNARCHIVING_DISK\n\n Value: 2\n\nStartup is waiting for the user's disk to be unarchived. This can happen\nwhen the user returns to Cloud Shell after not having used it for a\nwhile, and suggests that startup will take longer than normal.\n\nGenerated from protobuf enum `UNARCHIVING_DISK = 2;`\n\n### AWAITING_COMPUTE_RESOURCES\n\n Value: 4\n\nStartup is waiting for compute resources to be assigned to the\nenvironment. This should normally happen very quickly, but an environment\nmight stay in this state for an extended period of time if the system is\nexperiencing heavy load.\n\nGenerated from protobuf enum `AWAITING_COMPUTE_RESOURCES = 4;`\n\n### FINISHED\n\n Value: 3\n\nStartup has completed. If the start operation was successful, the user\nshould be able to establish an SSH connection to their environment.\n\nOtherwise, the operation will contain details of the failure.\n\nGenerated from protobuf enum `FINISHED = 3;`"]]