Class: Google::Apis::CloudkmsV1::CryptoKeyVersion

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
generated/google/apis/cloudkms_v1/classes.rb,
generated/google/apis/cloudkms_v1/representations.rb,
generated/google/apis/cloudkms_v1/representations.rb

Overview

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.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Google::Apis::Core::JsonObjectSupport

#to_json

Methods included from Google::Apis::Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ CryptoKeyVersion

Returns a new instance of CryptoKeyVersion



423
424
425
 
# File 'generated/google/apis/cloudkms_v1/classes.rb', line 423

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#algorithm ⇒ String

Output only. The CryptoKeyVersionAlgorithm that this CryptoKeyVersion supports. Corresponds to the JSON property algorithm

Returns:

  • (String) 


374
375
376
 
# File 'generated/google/apis/cloudkms_v1/classes.rb', line 374

def algorithm
  @algorithm
end

#attestation ⇒ Google::Apis::CloudkmsV1::KeyOperationAttestation

Contains an HSM-generated attestation about a key operation. Corresponds to the JSON property attestation

Returns:



379
380
381
 
# File 'generated/google/apis/cloudkms_v1/classes.rb', line 379

def attestation
  @attestation
end

#create_time ⇒ String

Output only. The time at which this CryptoKeyVersion was created. Corresponds to the JSON property createTime

Returns:

  • (String) 


384
385
386
 
# File 'generated/google/apis/cloudkms_v1/classes.rb', line 384

def create_time
  @create_time
end

#destroy_event_time ⇒ String

Output only. The time this CryptoKeyVersion's key material was destroyed. Only present if state is DESTROYED. Corresponds to the JSON property destroyEventTime

Returns:

  • (String) 


391
392
393
 
# File 'generated/google/apis/cloudkms_v1/classes.rb', line 391

def destroy_event_time
  @destroy_event_time
end

#destroy_time ⇒ String

Output only. The time this CryptoKeyVersion's key material is scheduled for destruction. Only present if state is DESTROY_SCHEDULED. Corresponds to the JSON property destroyTime

Returns:

  • (String) 


398
399
400
 
# File 'generated/google/apis/cloudkms_v1/classes.rb', line 398

def destroy_time
  @destroy_time
end

#generate_time ⇒ String

Output only. The time this CryptoKeyVersion's key material was generated. Corresponds to the JSON property generateTime

Returns:

  • (String) 


404
405
406
 
# File 'generated/google/apis/cloudkms_v1/classes.rb', line 404

def generate_time
  @generate_time
end

#name ⇒ String

Output only. The resource name for this CryptoKeyVersion in the format projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*. Corresponds to the JSON property name

Returns:

  • (String) 


410
411
412
 
# File 'generated/google/apis/cloudkms_v1/classes.rb', line 410

def name
  @name
end

#protection_level ⇒ String

Output only. The ProtectionLevel describing how crypto operations are performed with this CryptoKeyVersion. Corresponds to the JSON property protectionLevel

Returns:

  • (String) 


416
417
418
 
# File 'generated/google/apis/cloudkms_v1/classes.rb', line 416

def protection_level
  @protection_level
end

#state ⇒ String

The current state of the CryptoKeyVersion. Corresponds to the JSON property state

Returns:

  • (String) 


421
422
423
 
# File 'generated/google/apis/cloudkms_v1/classes.rb', line 421

def state
  @state
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



428
429
430
431
432
433
434
435
436
437
438
 
# File 'generated/google/apis/cloudkms_v1/classes.rb', line 428

def update!(**args)
  @algorithm = args[:algorithm] if args.key?(:algorithm)
  @attestation = args[:attestation] if args.key?(:attestation)
  @create_time = args[:create_time] if args.key?(:create_time)
  @destroy_event_time = args[:destroy_event_time] if args.key?(:destroy_event_time)
  @destroy_time = args[:destroy_time] if args.key?(:destroy_time)
  @generate_time = args[:generate_time] if args.key?(:generate_time)
  @name = args[:name] if args.key?(:name)
  @protection_level = args[:protection_level] if args.key?(:protection_level)
  @state = args[:state] if args.key?(:state)
end