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



257
258
259
 
# File 'generated/google/apis/cloudkms_v1/classes.rb', line 257

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) 


207
208
209
 
# File 'generated/google/apis/cloudkms_v1/classes.rb', line 207

def create_time
  @create_time
end

#labels ⇒ Hash<String,String>

Labels with user defined metadata. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


212
213
214
 
# File 'generated/google/apis/cloudkms_v1/classes.rb', line 212

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) 


218
219
220
 
# File 'generated/google/apis/cloudkms_v1/classes.rb', line 218

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) 


229
230
231
 
# File 'generated/google/apis/cloudkms_v1/classes.rb', line 229

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. 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 or decrypt data when an authorized user or application invokes Cloud KMS. Corresponds to the JSON property primary

Returns:



242
243
244
 
# File 'generated/google/apis/cloudkms_v1/classes.rb', line 242

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) 


248
249
250
 
# File 'generated/google/apis/cloudkms_v1/classes.rb', line 248

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) 


255
256
257
 
# File 'generated/google/apis/cloudkms_v1/classes.rb', line 255

def rotation_period
  @rotation_period
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



262
263
264
265
266
267
268
269
270
 
# File 'generated/google/apis/cloudkms_v1/classes.rb', line 262

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