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

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 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

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

#to_json

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

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ CryptoKey

Returns a new instance of CryptoKey.


445
446
447
# File 'generated/google/apis/cloudkms_v1/classes.rb', line 445

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

Instance Attribute Details

#create_timeString

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

Returns:

  • (String)

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

def create_time
  @create_time
end

#labelsHash<String,String>

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

Returns:

  • (Hash<String,String>)

396
397
398
# File 'generated/google/apis/cloudkms_v1/classes.rb', line 396

def labels
  @labels
end

#nameString

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

Returns:

  • (String)

402
403
404
# File 'generated/google/apis/cloudkms_v1/classes.rb', line 402

def name
  @name
end

#next_rotation_timeString

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)

412
413
414
# File 'generated/google/apis/cloudkms_v1/classes.rb', line 412

def next_rotation_time
  @next_rotation_time
end

#primaryGoogle::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


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

def primary
  @primary
end

#purposeString

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

Returns:

  • (String)

427
428
429
# File 'generated/google/apis/cloudkms_v1/classes.rb', line 427

def purpose
  @purpose
end

#rotation_periodString

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)

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

def rotation_period
  @rotation_period
end

#version_templateGoogle::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


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

def version_template
  @version_template
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


450
451
452
453
454
455
456
457
458
459
# File 'generated/google/apis/cloudkms_v1/classes.rb', line 450

def update!(**args)
  @create_time = args[:create_time] if args.key?(:create_time)
  @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