Class: Google::Apis::CloudkmsV1::KeyHandle

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

Resource-oriented representation of a request to Cloud KMS Autokey and the resulting provisioning of a CryptoKey.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ KeyHandle

Returns a new instance of KeyHandle.



1554
1555
1556
 
# File 'lib/google/apis/cloudkms_v1/classes.rb', line 1554

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

Instance Attribute Details

#kms_key ⇒ String

Output only. Name of a CryptoKey that has been provisioned for Customer Managed Encryption Key (CMEK) use in the KeyHandle's project and location for the requested resource type. Corresponds to the JSON property kmsKey

Returns:

  • (String) 


1539
1540
1541
 
# File 'lib/google/apis/cloudkms_v1/classes.rb', line 1539

def kms_key
  @kms_key
end

#name ⇒ String

Output only. Identifier. Name of the [KeyHandle] resource, e.g. projects/ PROJECT_ID/locations/LOCATION/keyHandles/KEY_HANDLE_ID`. Corresponds to the JSON propertyname`

Returns:

  • (String) 


1545
1546
1547
 
# File 'lib/google/apis/cloudkms_v1/classes.rb', line 1545

def name
  @name
end

#resource_type_selector ⇒ String

Required. Indicates the resource type that the resulting CryptoKey is meant to protect, e.g. SERVICE`.googleapis.com/`TYPE. See documentation for supported resource types. Corresponds to the JSON property resourceTypeSelector

Returns:

  • (String) 


1552
1553
1554
 
# File 'lib/google/apis/cloudkms_v1/classes.rb', line 1552

def resource_type_selector
  @resource_type_selector
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1559
1560
1561
1562
1563
 
# File 'lib/google/apis/cloudkms_v1/classes.rb', line 1559

def update!(**args)
  @kms_key = args[:kms_key] if args.key?(:kms_key)
  @name = args[:name] if args.key?(:name)
  @resource_type_selector = args[:resource_type_selector] if args.key?(:resource_type_selector)
end