Package com.google.cloud.shell.v1

Enum StartEnvironmentMetadata.State

java.lang.Object
java.lang.Enum<StartEnvironmentMetadata.State>
com.google.cloud.shell.v1.StartEnvironmentMetadata.State
All Implemented Interfaces:
com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<StartEnvironmentMetadata.State>
Enclosing class:
StartEnvironmentMetadata
public static enum StartEnvironmentMetadata.State extends Enum<StartEnvironmentMetadata.State> implements com.google.protobuf.ProtocolMessageEnum
 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 enum google.cloud.shell.v1.StartEnvironmentMetadata.State

  • Enum Constant Details

    • STATE_UNSPECIFIED

      public static final StartEnvironmentMetadata.State STATE_UNSPECIFIED
       The environment's start state is unknown.
      STATE_UNSPECIFIED = 0;

    • STARTING

      public static final StartEnvironmentMetadata.State STARTING
       The environment is in the process of being started, but no additional
 details are available.
      STARTING = 1;

    • UNARCHIVING_DISK

      public static final StartEnvironmentMetadata.State UNARCHIVING_DISK
       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;

    • AWAITING_COMPUTE_RESOURCES

      public static final StartEnvironmentMetadata.State AWAITING_COMPUTE_RESOURCES
       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;

    • FINISHED

      public static final StartEnvironmentMetadata.State 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.
      FINISHED = 3;

    • UNRECOGNIZED

      public static final StartEnvironmentMetadata.State UNRECOGNIZED

  • Field Details

    • STATE_UNSPECIFIED_VALUE

      public static final int STATE_UNSPECIFIED_VALUE
       The environment's start state is unknown.
      STATE_UNSPECIFIED = 0;
      See Also:

    • STARTING_VALUE

      public static final int STARTING_VALUE
       The environment is in the process of being started, but no additional
 details are available.
      STARTING = 1;
      See Also:

    • UNARCHIVING_DISK_VALUE

      public static final int UNARCHIVING_DISK_VALUE
       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;
      See Also:

    • AWAITING_COMPUTE_RESOURCES_VALUE

      public static final int AWAITING_COMPUTE_RESOURCES_VALUE
       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;
      See Also:

    • FINISHED_VALUE

      public static final int FINISHED_VALUE
       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;
      See Also:

  • Method Details

    • values

      public static StartEnvironmentMetadata.State[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static StartEnvironmentMetadata.State valueOf(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null

    • getNumber

      public final int getNumber()
      Specified by:
      getNumber in interface com.google.protobuf.Internal.EnumLite
      Specified by:
      getNumber in interface com.google.protobuf.ProtocolMessageEnum

    • valueOf

      @Deprecated public static StartEnvironmentMetadata.State valueOf(int value)
      Deprecated.
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      value - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null

    • forNumber

      public static StartEnvironmentMetadata.State forNumber(int value)
      Parameters:
      value - The numeric wire value of the corresponding enum entry.
      Returns:
      The enum associated with the given numeric wire value.

    • internalGetValueMap

      public static com.google.protobuf.Internal.EnumLiteMap<StartEnvironmentMetadata.State> internalGetValueMap()

    • getValueDescriptor

      public final com.google.protobuf.Descriptors.EnumValueDescriptor getValueDescriptor()
      Specified by:
      getValueDescriptor in interface com.google.protobuf.ProtocolMessageEnum

    • getDescriptorForType

      public final com.google.protobuf.Descriptors.EnumDescriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.ProtocolMessageEnum

    • getDescriptor

      public static com.google.protobuf.Descriptors.EnumDescriptor getDescriptor()

    • valueOf

      public static StartEnvironmentMetadata.State valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      desc - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null