Package com.google.cloud.kms.v1

Enum CryptoKeyVersion.CryptoKeyVersionState

java.lang.Object
java.lang.Enum<CryptoKeyVersion.CryptoKeyVersionState>
com.google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionState
All Implemented Interfaces:
com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<CryptoKeyVersion.CryptoKeyVersionState>
Enclosing class:
CryptoKeyVersion
public static enum CryptoKeyVersion.CryptoKeyVersionState extends Enum<CryptoKeyVersion.CryptoKeyVersionState> implements com.google.protobuf.ProtocolMessageEnum
 The state of a [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion],
 indicating if it can be used.
Protobuf enum google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionState

  • Enum Constant Details

    • CRYPTO_KEY_VERSION_STATE_UNSPECIFIED

      public static final CryptoKeyVersion.CryptoKeyVersionState CRYPTO_KEY_VERSION_STATE_UNSPECIFIED
       Not specified.
      CRYPTO_KEY_VERSION_STATE_UNSPECIFIED = 0;

    • PENDING_GENERATION

      public static final CryptoKeyVersion.CryptoKeyVersionState PENDING_GENERATION
       This version is still being generated. It may not be used, enabled,
 disabled, or destroyed yet. Cloud KMS will automatically mark this
 version
 [ENABLED][google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionState.ENABLED]
 as soon as the version is ready.
      PENDING_GENERATION = 5;

    • ENABLED

      public static final CryptoKeyVersion.CryptoKeyVersionState ENABLED
       This version may be used for cryptographic operations.
      ENABLED = 1;

    • DISABLED

      public static final CryptoKeyVersion.CryptoKeyVersionState DISABLED
       This version may not be used, but the key material is still available,
 and the version can be placed back into the
 [ENABLED][google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionState.ENABLED]
 state.
      DISABLED = 2;

    • DESTROYED

      public static final CryptoKeyVersion.CryptoKeyVersionState DESTROYED
       The key material of this version is destroyed and no longer stored.
 This version may only become
 [ENABLED][google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionState.ENABLED]
 again if this version is
 [reimport_eligible][google.cloud.kms.v1.CryptoKeyVersion.reimport_eligible]
 and the original key material is reimported with a call to
 [KeyManagementService.ImportCryptoKeyVersion][google.cloud.kms.v1.KeyManagementService.ImportCryptoKeyVersion].
      DESTROYED = 3;

    • DESTROY_SCHEDULED

      public static final CryptoKeyVersion.CryptoKeyVersionState DESTROY_SCHEDULED
       This version is scheduled for destruction, and will be destroyed soon.
 Call
 [RestoreCryptoKeyVersion][google.cloud.kms.v1.KeyManagementService.RestoreCryptoKeyVersion]
 to put it back into the
 [DISABLED][google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionState.DISABLED]
 state.
      DESTROY_SCHEDULED = 4;

    • PENDING_IMPORT

      public static final CryptoKeyVersion.CryptoKeyVersionState PENDING_IMPORT
       This version is still being imported. It may not be used, enabled,
 disabled, or destroyed yet. Cloud KMS will automatically mark this
 version
 [ENABLED][google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionState.ENABLED]
 as soon as the version is ready.
      PENDING_IMPORT = 6;

    • IMPORT_FAILED

      public static final CryptoKeyVersion.CryptoKeyVersionState IMPORT_FAILED
       This version was not imported successfully. It may not be used, enabled,
 disabled, or destroyed. The submitted key material has been discarded.
 Additional details can be found in
 [CryptoKeyVersion.import_failure_reason][google.cloud.kms.v1.CryptoKeyVersion.import_failure_reason].
      IMPORT_FAILED = 7;

    • GENERATION_FAILED

      public static final CryptoKeyVersion.CryptoKeyVersionState GENERATION_FAILED
       This version was not generated successfully. It may not be used, enabled,
 disabled, or destroyed. Additional details can be found in
 [CryptoKeyVersion.generation_failure_reason][google.cloud.kms.v1.CryptoKeyVersion.generation_failure_reason].
      GENERATION_FAILED = 8;

    • PENDING_EXTERNAL_DESTRUCTION

      public static final CryptoKeyVersion.CryptoKeyVersionState PENDING_EXTERNAL_DESTRUCTION
       This version was destroyed, and it may not be used or enabled again.
 Cloud KMS is waiting for the corresponding key material residing in an
 external key manager to be destroyed.
      PENDING_EXTERNAL_DESTRUCTION = 9;

    • EXTERNAL_DESTRUCTION_FAILED

      public static final CryptoKeyVersion.CryptoKeyVersionState EXTERNAL_DESTRUCTION_FAILED
       This version was destroyed, and it may not be used or enabled again.
 However, Cloud KMS could not confirm that the corresponding key material
 residing in an external key manager was destroyed. Additional details can
 be found in
 [CryptoKeyVersion.external_destruction_failure_reason][google.cloud.kms.v1.CryptoKeyVersion.external_destruction_failure_reason].
      EXTERNAL_DESTRUCTION_FAILED = 10;

    • UNRECOGNIZED

      public static final CryptoKeyVersion.CryptoKeyVersionState UNRECOGNIZED

  • Field Details

    • CRYPTO_KEY_VERSION_STATE_UNSPECIFIED_VALUE

      public static final int CRYPTO_KEY_VERSION_STATE_UNSPECIFIED_VALUE
       Not specified.
      CRYPTO_KEY_VERSION_STATE_UNSPECIFIED = 0;
      See Also:

    • PENDING_GENERATION_VALUE

      public static final int PENDING_GENERATION_VALUE
       This version is still being generated. It may not be used, enabled,
 disabled, or destroyed yet. Cloud KMS will automatically mark this
 version
 [ENABLED][google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionState.ENABLED]
 as soon as the version is ready.
      PENDING_GENERATION = 5;
      See Also:

    • ENABLED_VALUE

      public static final int ENABLED_VALUE
       This version may be used for cryptographic operations.
      ENABLED = 1;
      See Also:

    • DISABLED_VALUE

      public static final int DISABLED_VALUE
       This version may not be used, but the key material is still available,
 and the version can be placed back into the
 [ENABLED][google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionState.ENABLED]
 state.
      DISABLED = 2;
      See Also:

    • DESTROYED_VALUE

      public static final int DESTROYED_VALUE
       The key material of this version is destroyed and no longer stored.
 This version may only become
 [ENABLED][google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionState.ENABLED]
 again if this version is
 [reimport_eligible][google.cloud.kms.v1.CryptoKeyVersion.reimport_eligible]
 and the original key material is reimported with a call to
 [KeyManagementService.ImportCryptoKeyVersion][google.cloud.kms.v1.KeyManagementService.ImportCryptoKeyVersion].
      DESTROYED = 3;
      See Also:

    • DESTROY_SCHEDULED_VALUE

      public static final int DESTROY_SCHEDULED_VALUE
       This version is scheduled for destruction, and will be destroyed soon.
 Call
 [RestoreCryptoKeyVersion][google.cloud.kms.v1.KeyManagementService.RestoreCryptoKeyVersion]
 to put it back into the
 [DISABLED][google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionState.DISABLED]
 state.
      DESTROY_SCHEDULED = 4;
      See Also:

    • PENDING_IMPORT_VALUE

      public static final int PENDING_IMPORT_VALUE
       This version is still being imported. It may not be used, enabled,
 disabled, or destroyed yet. Cloud KMS will automatically mark this
 version
 [ENABLED][google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionState.ENABLED]
 as soon as the version is ready.
      PENDING_IMPORT = 6;
      See Also:

    • IMPORT_FAILED_VALUE

      public static final int IMPORT_FAILED_VALUE
       This version was not imported successfully. It may not be used, enabled,
 disabled, or destroyed. The submitted key material has been discarded.
 Additional details can be found in
 [CryptoKeyVersion.import_failure_reason][google.cloud.kms.v1.CryptoKeyVersion.import_failure_reason].
      IMPORT_FAILED = 7;
      See Also:

    • GENERATION_FAILED_VALUE

      public static final int GENERATION_FAILED_VALUE
       This version was not generated successfully. It may not be used, enabled,
 disabled, or destroyed. Additional details can be found in
 [CryptoKeyVersion.generation_failure_reason][google.cloud.kms.v1.CryptoKeyVersion.generation_failure_reason].
      GENERATION_FAILED = 8;
      See Also:

    • PENDING_EXTERNAL_DESTRUCTION_VALUE

      public static final int PENDING_EXTERNAL_DESTRUCTION_VALUE
       This version was destroyed, and it may not be used or enabled again.
 Cloud KMS is waiting for the corresponding key material residing in an
 external key manager to be destroyed.
      PENDING_EXTERNAL_DESTRUCTION = 9;
      See Also:

    • EXTERNAL_DESTRUCTION_FAILED_VALUE

      public static final int EXTERNAL_DESTRUCTION_FAILED_VALUE
       This version was destroyed, and it may not be used or enabled again.
 However, Cloud KMS could not confirm that the corresponding key material
 residing in an external key manager was destroyed. Additional details can
 be found in
 [CryptoKeyVersion.external_destruction_failure_reason][google.cloud.kms.v1.CryptoKeyVersion.external_destruction_failure_reason].
      EXTERNAL_DESTRUCTION_FAILED = 10;
      See Also:

  • Method Details

    • values

      public static CryptoKeyVersion.CryptoKeyVersionState[] 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 CryptoKeyVersion.CryptoKeyVersionState 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 CryptoKeyVersion.CryptoKeyVersionState 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 CryptoKeyVersion.CryptoKeyVersionState 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<CryptoKeyVersion.CryptoKeyVersionState> 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 CryptoKeyVersion.CryptoKeyVersionState 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