Reference documentation and code samples for the Cloud Key Management Service (KMS) V1 API class Google::Cloud::Kms::V1::KeyHandle.
Resource-oriented representation of a request to Cloud KMS Autokey and the resulting provisioning of a CryptoKey .
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#kms_key
def
kms_key
()
-
>
::
String
Returns
- (::String) — Output only. Name of a CryptoKey that has been provisioned for Customer Managed Encryption Key (CMEK) use in the KeyHandle project and location for the requested resource type. The CryptoKey project will reflect the value configured in the AutokeyConfig on the resource project's ancestor folder at the time of the KeyHandle creation. If more than one ancestor folder has a configured AutokeyConfig , the nearest of these configurations is used.
#name
def
name
()
-
>
::
String
Returns
- (::String) — Identifier. Name of the KeyHandle
resource, e.g.
projects/{PROJECT_ID}/locations/{LOCATION}/keyHandles/{KEY_HANDLE_ID}.
#name=
def
name=
(
value
)
-
>
::
String
Parameter
- value(::String) — Identifier. Name of the KeyHandle
resource, e.g.
projects/{PROJECT_ID}/locations/{LOCATION}/keyHandles/{KEY_HANDLE_ID}.
Returns
- (::String) — Identifier. Name of the KeyHandle
resource, e.g.
projects/{PROJECT_ID}/locations/{LOCATION}/keyHandles/{KEY_HANDLE_ID}.
#resource_type_selector
def
resource_type_selector
()
-
>
::
String
Returns
- (::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.
#resource_type_selector=
def
resource_type_selector=
(
value
)
-
>
::
String
Parameter
- value(::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.
Returns
- (::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.
