Package com.google.cloud.kms.v1

Enum SingleTenantHsmInstance.State

java.lang.Object
java.lang.Enum<SingleTenantHsmInstance.State>
com.google.cloud.kms.v1.SingleTenantHsmInstance.State
All Implemented Interfaces:
com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<SingleTenantHsmInstance.State>
Enclosing class:
SingleTenantHsmInstance
public static enum SingleTenantHsmInstance.State extends Enum<SingleTenantHsmInstance.State> implements com.google.protobuf.ProtocolMessageEnum
 The set of states of a
 [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance].
Protobuf enum google.cloud.kms.v1.SingleTenantHsmInstance.State

  • Enum Constant Details

    • STATE_UNSPECIFIED

      public static final SingleTenantHsmInstance.State STATE_UNSPECIFIED
       Not specified.
      STATE_UNSPECIFIED = 0;

    • CREATING

      public static final SingleTenantHsmInstance.State CREATING
       The
 [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance] is
 being created.
      CREATING = 1;

    • PENDING_TWO_FACTOR_AUTH_REGISTRATION

      public static final SingleTenantHsmInstance.State PENDING_TWO_FACTOR_AUTH_REGISTRATION
       The
 [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance] is
 waiting for 2FA keys to be registered. This can be done by calling
 [CreateSingleTenantHsmInstanceProposal][google.cloud.kms.v1.HsmManagement.CreateSingleTenantHsmInstanceProposal]
 with the [RegisterTwoFactorAuthKeys][] operation.
      PENDING_TWO_FACTOR_AUTH_REGISTRATION = 2;

    • ACTIVE

      public static final SingleTenantHsmInstance.State ACTIVE
       The
 [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance] is
 ready to use. A
 [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance]
 must be in the
 [ACTIVE][google.cloud.kms.v1.SingleTenantHsmInstance.State.ACTIVE] state
 for all [CryptoKeys][google.cloud.kms.v1.CryptoKey] created within the
 [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance] to
 be usable.
      ACTIVE = 3;

    • DISABLING

      public static final SingleTenantHsmInstance.State DISABLING
       The
 [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance] is
 being disabled.
      DISABLING = 4;

    • DISABLED

      public static final SingleTenantHsmInstance.State DISABLED
       The
 [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance] is
 disabled.
      DISABLED = 5;

    • DELETING

      public static final SingleTenantHsmInstance.State DELETING
       The
 [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance] is
 being deleted. Requests to the instance will be rejected in this state.
      DELETING = 6;

    • DELETED

      public static final SingleTenantHsmInstance.State DELETED
       The
 [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance]
 has been deleted.
      DELETED = 7;

    • FAILED

      public static final SingleTenantHsmInstance.State FAILED
       The
 [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance]
 has failed and can not be recovered or used.
      FAILED = 8;

    • UNRECOGNIZED

      public static final SingleTenantHsmInstance.State UNRECOGNIZED

  • Field Details

    • STATE_UNSPECIFIED_VALUE

      public static final int STATE_UNSPECIFIED_VALUE
       Not specified.
      STATE_UNSPECIFIED = 0;
      See Also:

    • CREATING_VALUE

      public static final int CREATING_VALUE
       The
 [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance] is
 being created.
      CREATING = 1;
      See Also:

    • PENDING_TWO_FACTOR_AUTH_REGISTRATION_VALUE

      public static final int PENDING_TWO_FACTOR_AUTH_REGISTRATION_VALUE
       The
 [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance] is
 waiting for 2FA keys to be registered. This can be done by calling
 [CreateSingleTenantHsmInstanceProposal][google.cloud.kms.v1.HsmManagement.CreateSingleTenantHsmInstanceProposal]
 with the [RegisterTwoFactorAuthKeys][] operation.
      PENDING_TWO_FACTOR_AUTH_REGISTRATION = 2;
      See Also:

    • ACTIVE_VALUE

      public static final int ACTIVE_VALUE
       The
 [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance] is
 ready to use. A
 [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance]
 must be in the
 [ACTIVE][google.cloud.kms.v1.SingleTenantHsmInstance.State.ACTIVE] state
 for all [CryptoKeys][google.cloud.kms.v1.CryptoKey] created within the
 [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance] to
 be usable.
      ACTIVE = 3;
      See Also:

    • DISABLING_VALUE

      public static final int DISABLING_VALUE
       The
 [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance] is
 being disabled.
      DISABLING = 4;
      See Also:

    • DISABLED_VALUE

      public static final int DISABLED_VALUE
       The
 [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance] is
 disabled.
      DISABLED = 5;
      See Also:

    • DELETING_VALUE

      public static final int DELETING_VALUE
       The
 [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance] is
 being deleted. Requests to the instance will be rejected in this state.
      DELETING = 6;
      See Also:

    • DELETED_VALUE

      public static final int DELETED_VALUE
       The
 [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance]
 has been deleted.
      DELETED = 7;
      See Also:

    • FAILED_VALUE

      public static final int FAILED_VALUE
       The
 [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance]
 has failed and can not be recovered or used.
      FAILED = 8;
      See Also:

  • Method Details

    • values

      public static SingleTenantHsmInstance.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 SingleTenantHsmInstance.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 SingleTenantHsmInstance.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 SingleTenantHsmInstance.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<SingleTenantHsmInstance.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 SingleTenantHsmInstance.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