Google Cloud Shell V1 Client - Class State (1.0.4)

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.

Protobuf type google.cloud.shell.v1.StartEnvironmentMetadata.State

Methods

name

Parameter
NameDescription
value mixed

value

Parameter
NameDescription
name mixed

Constants

STATE_UNSPECIFIED

Value: 0

The environment's start state is unknown.

Generated from protobuf enum STATE_UNSPECIFIED = 0;

STARTING

Value: 1

The environment is in the process of being started, but no additional details are available.

Generated from protobuf enum STARTING = 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 enum UNARCHIVING_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 enum AWAITING_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.

Generated from protobuf enum FINISHED = 3;