Class: Google::Apis::KmsinventoryV1::GoogleCloudKmsV1CryptoKeyVersion

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/kmsinventory_v1/classes.rb,
lib/google/apis/kmsinventory_v1/representations.rb,
lib/google/apis/kmsinventory_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

Constructor Details

#initialize(**args) ⇒ GoogleCloudKmsV1CryptoKeyVersion

Returns a new instance of GoogleCloudKmsV1CryptoKeyVersion.



434
435
436
 
# File 'lib/google/apis/kmsinventory_v1/classes.rb', line 434

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) 


341
342
343
 
# File 'lib/google/apis/kmsinventory_v1/classes.rb', line 341

def algorithm
  @algorithm
end

#attestation ⇒ Google::Apis::KmsinventoryV1::GoogleCloudKmsV1KeyOperationAttestation

Contains an HSM-generated attestation about a key operation. For more information, see Verifying attestations. Corresponds to the JSON property attestation

Returns:



348
349
350
 
# File 'lib/google/apis/kmsinventory_v1/classes.rb', line 348

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) 


353
354
355
 
# File 'lib/google/apis/kmsinventory_v1/classes.rb', line 353

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) 


359
360
361
 
# File 'lib/google/apis/kmsinventory_v1/classes.rb', line 359

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) 


365
366
367
 
# File 'lib/google/apis/kmsinventory_v1/classes.rb', line 365

def destroy_time
  @destroy_time
end

#external_destruction_failure_reason ⇒ String

Output only. The root cause of the most recent external destruction failure. Only present if state is EXTERNAL_DESTRUCTION_FAILED. Corresponds to the JSON property externalDestructionFailureReason

Returns:

  • (String) 


371
372
373
 
# File 'lib/google/apis/kmsinventory_v1/classes.rb', line 371

def external_destruction_failure_reason
  @external_destruction_failure_reason
end

#external_protection_level_options ⇒ Google::Apis::KmsinventoryV1::GoogleCloudKmsV1ExternalProtectionLevelOptions

ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels. Corresponds to the JSON property externalProtectionLevelOptions

Returns:



378
379
380
 
# File 'lib/google/apis/kmsinventory_v1/classes.rb', line 378

def external_protection_level_options
  @external_protection_level_options
end

#generate_time ⇒ String

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

Returns:

  • (String) 


383
384
385
 
# File 'lib/google/apis/kmsinventory_v1/classes.rb', line 383

def generate_time
  @generate_time
end

#generation_failure_reason ⇒ String

Output only. The root cause of the most recent generation failure. Only present if state is GENERATION_FAILED. Corresponds to the JSON property generationFailureReason

Returns:

  • (String) 


389
390
391
 
# File 'lib/google/apis/kmsinventory_v1/classes.rb', line 389

def generation_failure_reason
  @generation_failure_reason
end

#import_failure_reason ⇒ String

Output only. The root cause of the most recent import failure. Only present if state is IMPORT_FAILED. Corresponds to the JSON property importFailureReason

Returns:

  • (String) 


395
396
397
 
# File 'lib/google/apis/kmsinventory_v1/classes.rb', line 395

def import_failure_reason
  @import_failure_reason
end

#import_job ⇒ 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. Corresponds to the JSON property importJob

Returns:

  • (String) 


401
402
403
 
# File 'lib/google/apis/kmsinventory_v1/classes.rb', line 401

def import_job
  @import_job
end

#import_time ⇒ String

Output only. The time at which this CryptoKeyVersion's key material was most recently imported. Corresponds to the JSON property importTime

Returns:

  • (String) 


407
408
409
 
# File 'lib/google/apis/kmsinventory_v1/classes.rb', line 407

def import_time
  @import_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) 


413
414
415
 
# File 'lib/google/apis/kmsinventory_v1/classes.rb', line 413

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) 


419
420
421
 
# File 'lib/google/apis/kmsinventory_v1/classes.rb', line 419

def protection_level
  @protection_level
end

#reimport_eligible ⇒ Boolean Also known as: reimport_eligible?

Output only. Whether or not this key version is eligible for reimport, by being specified as a target in ImportCryptoKeyVersionRequest. crypto_key_version. Corresponds to the JSON property reimportEligible

Returns:

  • (Boolean) 


426
427
428
 
# File 'lib/google/apis/kmsinventory_v1/classes.rb', line 426

def reimport_eligible
  @reimport_eligible
end

#state ⇒ String

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

Returns:

  • (String) 


432
433
434
 
# File 'lib/google/apis/kmsinventory_v1/classes.rb', line 432

def state
  @state
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
 
# File 'lib/google/apis/kmsinventory_v1/classes.rb', line 439

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)
  @external_destruction_failure_reason = args[:external_destruction_failure_reason] if args.key?(:external_destruction_failure_reason)
  @external_protection_level_options = args[:external_protection_level_options] if args.key?(:external_protection_level_options)
  @generate_time = args[:generate_time] if args.key?(:generate_time)
  @generation_failure_reason = args[:generation_failure_reason] if args.key?(:generation_failure_reason)
  @import_failure_reason = args[:import_failure_reason] if args.key?(:import_failure_reason)
  @import_job = args[:import_job] if args.key?(:import_job)
  @import_time = args[:import_time] if args.key?(:import_time)
  @name = args[:name] if args.key?(:name)
  @protection_level = args[:protection_level] if args.key?(:protection_level)
  @reimport_eligible = args[:reimport_eligible] if args.key?(:reimport_eligible)
  @state = args[:state] if args.key?(:state)
end