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



647
648
649
 
# File 'generated/google/apis/cloudkms_v1/classes.rb', line 647

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) 


638
639
640
 
# File 'generated/google/apis/cloudkms_v1/classes.rb', line 638

def create_time
  @create_time
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) 


616
617
618
 
# File 'generated/google/apis/cloudkms_v1/classes.rb', line 616

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. Corresponds to the JSON property nextRotationTime

Returns:

  • (String) 


633
634
635
 
# File 'generated/google/apis/cloudkms_v1/classes.rb', line 633

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. It can be used for cryptographic operations either directly, or via its parent CryptoKey, in which case the server will choose the appropriate version for the operation. Corresponds to the JSON property primary

Returns:



610
611
612
 
# File 'generated/google/apis/cloudkms_v1/classes.rb', line 610

def primary
  @primary
end

#purpose ⇒ String

The immutable purpose of this CryptoKey. Currently, the only acceptable purpose is ENCRYPT_DECRYPT. Corresponds to the JSON property purpose

Returns:

  • (String) 


622
623
624
 
# File 'generated/google/apis/cloudkms_v1/classes.rb', line 622

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 one day. If rotation_period is set, next_rotation_time must also be set. Corresponds to the JSON property rotationPeriod

Returns:

  • (String) 


645
646
647
 
# File 'generated/google/apis/cloudkms_v1/classes.rb', line 645

def rotation_period
  @rotation_period
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



652
653
654
655
656
657
658
659
 
# File 'generated/google/apis/cloudkms_v1/classes.rb', line 652

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