Class: Google::Apis::CloudkmsV1::CryptoKey

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

Overview

A CryptoKey represents a logical key that can be used for cryptographic operations. A CryptoKey is made up of zero or more versions, which represent the actual key material used in cryptographic operations.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ CryptoKey

Returns a new instance of CryptoKey.



504
505
506
 
# File 'lib/google/apis/cloudkms_v1/classes.rb', line 504

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

Instance Attribute Details

#create_time ⇒ String

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

Returns:

  • (String) 


436
437
438
 
# File 'lib/google/apis/cloudkms_v1/classes.rb', line 436

def create_time
  @create_time
end

#destroy_scheduled_duration ⇒ String

Immutable. The period of time that versions of this key spend in the DESTROY_SCHEDULED state before transitioning to DESTROYED. If not specified at creation time, the default duration is 24 hours. Corresponds to the JSON property destroyScheduledDuration

Returns:

  • (String) 


443
444
445
 
# File 'lib/google/apis/cloudkms_v1/classes.rb', line 443

def destroy_scheduled_duration
  @destroy_scheduled_duration
end

#import_only ⇒ Boolean Also known as: import_only?

Immutable. Whether this key may contain imported versions only. Corresponds to the JSON property importOnly

Returns:

  • (Boolean) 


448
449
450
 
# File 'lib/google/apis/cloudkms_v1/classes.rb', line 448

def import_only
  @import_only
end

#labels ⇒ Hash<String,String>

Labels with user-defined metadata. For more information, see Labeling Keys. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


455
456
457
 
# File 'lib/google/apis/cloudkms_v1/classes.rb', line 455

def labels
  @labels
end

#name ⇒ String

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

Returns:

  • (String) 


461
462
463
 
# File 'lib/google/apis/cloudkms_v1/classes.rb', line 461

def name
  @name
end

#next_rotation_time ⇒ String

At next_rotation_time, the Key Management Service will automatically: 1. Create a new version of this CryptoKey. 2. Mark the new version as primary. Key rotations performed manually via CreateCryptoKeyVersion and UpdateCryptoKeyPrimaryVersion do not affect next_rotation_time. Keys with purpose ENCRYPT_DECRYPT support automatic rotation. For other keys, this field must be omitted. Corresponds to the JSON property nextRotationTime

Returns:

  • (String) 


471
472
473
 
# File 'lib/google/apis/cloudkms_v1/classes.rb', line 471

def next_rotation_time
  @next_rotation_time
end

#primary ⇒ Google::Apis::CloudkmsV1::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. Corresponds to the JSON property primary

Returns:



481
482
483
 
# File 'lib/google/apis/cloudkms_v1/classes.rb', line 481

def primary
  @primary
end

#purpose ⇒ String

Immutable. The immutable purpose of this CryptoKey. Corresponds to the JSON property purpose

Returns:

  • (String) 


486
487
488
 
# File 'lib/google/apis/cloudkms_v1/classes.rb', line 486

def purpose
  @purpose
end

#rotation_period ⇒ String

next_rotation_time will be advanced by this period when the service automatically rotates a key. Must be at least 24 hours and at most 876,000 hours. If rotation_period is set, next_rotation_time must also be set. Keys with purpose ENCRYPT_DECRYPT support automatic rotation. For other keys, this field must be omitted. Corresponds to the JSON property rotationPeriod

Returns:

  • (String) 


495
496
497
 
# File 'lib/google/apis/cloudkms_v1/classes.rb', line 495

def rotation_period
  @rotation_period
end

#version_template ⇒ Google::Apis::CloudkmsV1::CryptoKeyVersionTemplate

A CryptoKeyVersionTemplate specifies the properties to use when creating a new CryptoKeyVersion, either manually with CreateCryptoKeyVersion or automatically as a result of auto-rotation. Corresponds to the JSON property versionTemplate

Returns:



502
503
504
 
# File 'lib/google/apis/cloudkms_v1/classes.rb', line 502

def version_template
  @version_template
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



509
510
511
512
513
514
515
516
517
518
519
520
 
# File 'lib/google/apis/cloudkms_v1/classes.rb', line 509

def update!(**args)
  @create_time = args[:create_time] if args.key?(:create_time)
  @destroy_scheduled_duration = args[:destroy_scheduled_duration] if args.key?(:destroy_scheduled_duration)
  @import_only = args[:import_only] if args.key?(:import_only)
  @labels = args[:labels] if args.key?(:labels)
  @name = args[:name] if args.key?(:name)
  @next_rotation_time = args[:next_rotation_time] if args.key?(:next_rotation_time)
  @primary = args[:primary] if args.key?(:primary)
  @purpose = args[:purpose] if args.key?(:purpose)
  @rotation_period = args[:rotation_period] if args.key?(:rotation_period)
  @version_template = args[:version_template] if args.key?(:version_template)
end