Cloud Key Management Service (KMS) V1 API - Class Google::Cloud::Kms::V1::CryptoKeyVersion (v1.0.2)

Reference documentation and code samples for the Cloud Key Management Service (KMS) V1 API class Google::Cloud::Kms::V1::CryptoKeyVersion.

A CryptoKeyVersion represents an individual cryptographic key, and the associated key material.

An ENABLED version can be used for cryptographic operations.

For security reasons, the raw cryptographic key material represented by a CryptoKeyVersion can never be viewed or exported. It can only be used to encrypt, decrypt, or sign data when an authorized user or application invokes Cloud KMS.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#algorithm

def algorithm() -> ::Google::Cloud::Kms::V1::CryptoKeyVersion::CryptoKeyVersionAlgorithm

#attestation

def attestation() -> ::Google::Cloud::Kms::V1::KeyOperationAttestation
Returns

#create_time

def create_time() -> ::Google::Protobuf::Timestamp
Returns

#destroy_event_time

def destroy_event_time() -> ::Google::Protobuf::Timestamp
Returns

#destroy_time

def destroy_time() -> ::Google::Protobuf::Timestamp
Returns

#external_destruction_failure_reason

def external_destruction_failure_reason() -> ::String
Returns

#external_protection_level_options

def external_protection_level_options() -> ::Google::Cloud::Kms::V1::ExternalProtectionLevelOptions
Returns

#external_protection_level_options=

def external_protection_level_options=(value) -> ::Google::Cloud::Kms::V1::ExternalProtectionLevelOptions
Parameter
Returns

#generate_time

def generate_time() -> ::Google::Protobuf::Timestamp
Returns

#generation_failure_reason

def generation_failure_reason() -> ::String
Returns
  • (::String) — Output only. The root cause of the most recent generation failure. Only present if state is GENERATION_FAILED.

#import_failure_reason

def import_failure_reason() -> ::String
Returns
  • (::String) — Output only. The root cause of the most recent import failure. Only present if state is IMPORT_FAILED.

#import_job

def import_job() -> ::String
Returns
  • (::String) — Output only. The name of the ImportJob used in the most recent import of this CryptoKeyVersion. Only present if the underlying key material was imported.

#import_time

def import_time() -> ::Google::Protobuf::Timestamp
Returns

#name

def name() -> ::String
Returns
  • (::String) — Output only. The resource name for this CryptoKeyVersion in the format projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*.

#protection_level

def protection_level() -> ::Google::Cloud::Kms::V1::ProtectionLevel
Returns

#reimport_eligible

def reimport_eligible() -> ::Boolean
Returns

#state

def state() -> ::Google::Cloud::Kms::V1::CryptoKeyVersion::CryptoKeyVersionState

#state=

def state=(value) -> ::Google::Cloud::Kms::V1::CryptoKeyVersion::CryptoKeyVersionState