Class: Google::Cloud::Shell::V1::StartEnvironmentMetadata

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/shell/v1/cloudshell.rb

Overview

Message included in the metadata field of operations returned from StartEnvironment.

Defined Under Namespace

Modules: State

Instance Attribute Summary collapse

Instance Attribute Details

#state ⇒ ::Google::Cloud::Shell::V1::StartEnvironmentMetadata::State

Returns Current state of the environment being started.

Returns:



183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'proto_docs/google/cloud/shell/v1/cloudshell.rb', line 183

class StartEnvironmentMetadata
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # 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.
  module State
    # The environment's start state is unknown.
    STATE_UNSPECIFIED = 0

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

    # 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.
    UNARCHIVING_DISK = 2

    # 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.
    AWAITING_COMPUTE_RESOURCES = 4

    # 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.
    FINISHED = 3
  end
end