com.google.api.services.cloudkms.v1.model

Class KeyHandle

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.cloudkms.v1.model.KeyHandle

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class KeyHandle
extends com.google.api.client.json.GenericJson

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

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Cloud Key Management Service (KMS) API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
KeyHandle()

Method Summary

Modifier and Type	Method and Description
KeyHandle	clone()
String	getKmsKey() Output only.
String	getName() Identifier.
String	getResourceTypeSelector() Required.
KeyHandle	set(String fieldName, Object value)
KeyHandle	setKmsKey(String kmsKey) Output only.
KeyHandle	setName(String name) Identifier.
KeyHandle	setResourceTypeSelector(String resourceTypeSelector) Required.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

KeyHandle

public KeyHandle()

Method Detail

getKmsKey

public String getKmsKey()

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.

Returns:

value or null for none

setKmsKey

public KeyHandle setKmsKey(String kmsKey)

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.

Parameters:

kmsKey - kmsKey or null for none

getName

public String getName()

Identifier. Name of the KeyHandle resource, e.g. `projects/{PROJECT_ID}/locations/{LOCATION}/keyHandles/{KEY_HANDLE_ID}`.

Returns:

value or null for none

setName

public KeyHandle setName(String name)

Identifier. Name of the KeyHandle resource, e.g. `projects/{PROJECT_ID}/locations/{LOCATION}/keyHandles/{KEY_HANDLE_ID}`.

Parameters:

name - name or null for none

getResourceTypeSelector

public String getResourceTypeSelector()

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:

value or null for none

setResourceTypeSelector

public KeyHandle setResourceTypeSelector(String resourceTypeSelector)

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.

Parameters:

resourceTypeSelector - resourceTypeSelector or null for none

set

public KeyHandle set(String fieldName,
                     Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public KeyHandle clone()

Overrides:

clone in class com.google.api.client.json.GenericJson