Cloud KMS V1 Client - Class CryptoKeyVersionState (1.17.0)

Version 1.17.0

• 2.1.2 (latest)
• 2.1.1
• 2.0.0
• 1.23.0
• 1.22.1
• 1.21.4
• 1.20.3
• 1.19.0
• 1.18.1
• 1.17.0
• 1.16.4
• 1.15.3

Reference documentation and code samples for the Cloud KMS V1 Client class CryptoKeyVersionState.

The state of a CryptoKeyVersion, indicating if it can be used.

Protobuf type google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionState

Methods

name

Parameter
Name	Description
value	mixed

value

Parameter
Name	Description
name	mixed

Constants

CRYPTO_KEY_VERSION_STATE_UNSPECIFIED

Value: 0

Not specified.

Generated from protobuf enum CRYPTO_KEY_VERSION_STATE_UNSPECIFIED = 0;

PENDING_GENERATION

Value: 5

This version is still being generated. It may not be used, enabled, disabled, or destroyed yet. Cloud KMS will automatically mark this version ENABLED as soon as the version is ready.

Generated from protobuf enum PENDING_GENERATION = 5;

ENABLED

Value: 1

This version may be used for cryptographic operations.

Generated from protobuf enum ENABLED = 1;

DISABLED

Value: 2

This version may not be used, but the key material is still available, and the version can be placed back into the ENABLED state.

Generated from protobuf enum DISABLED = 2;

DESTROYED

Value: 3

This version is destroyed, and the key material is no longer stored.

This version may only become ENABLED again if this version is reimport_eligible and the original key material is reimported with a call to KeyManagementService.ImportCryptoKeyVersion.

Generated from protobuf enum DESTROYED = 3;

DESTROY_SCHEDULED

Value: 4

This version is scheduled for destruction, and will be destroyed soon.

Call RestoreCryptoKeyVersion to put it back into the DISABLED state.

Generated from protobuf enum DESTROY_SCHEDULED = 4;

PENDING_IMPORT

Value: 6

This version is still being imported. It may not be used, enabled, disabled, or destroyed yet. Cloud KMS will automatically mark this version ENABLED as soon as the version is ready.

Generated from protobuf enum PENDING_IMPORT = 6;

IMPORT_FAILED

Value: 7

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.

Generated from protobuf enum IMPORT_FAILED = 7;

GENERATION_FAILED

Value: 8

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.

Generated from protobuf enum GENERATION_FAILED = 8;

PENDING_EXTERNAL_DESTRUCTION

Value: 9

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.

Generated from protobuf enum PENDING_EXTERNAL_DESTRUCTION = 9;

EXTERNAL_DESTRUCTION_FAILED

Value: 10

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.

Generated from protobuf enum EXTERNAL_DESTRUCTION_FAILED = 10;