com.google.api.services.healthcare.v1beta1.model

Class KmsWrappedCryptoKey

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.healthcare.v1beta1.model.KmsWrappedCryptoKey

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. The key must grant the Cloud IAM permission `cloudkms.cryptoKeyVersions.useToDecrypt` to the project's Cloud Healthcare Service Agent service account. For more information, see [Creating a wrapped key] (https://cloud.google.com/dlp/docs/create-wrapped-key).

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 Healthcare 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
KmsWrappedCryptoKey()

Method Summary

Modifier and Type	Method and Description
KmsWrappedCryptoKey	clone()
byte[]	decodeWrappedKey() Required.
KmsWrappedCryptoKey	encodeWrappedKey(byte[] wrappedKey) Required.
String	getCryptoKey() Required.
String	getWrappedKey() Required.
KmsWrappedCryptoKey	set(String fieldName, Object value)
KmsWrappedCryptoKey	setCryptoKey(String cryptoKey) Required.
KmsWrappedCryptoKey	setWrappedKey(String wrappedKey) 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

KmsWrappedCryptoKey

public KmsWrappedCryptoKey()

Method Detail

getCryptoKey

public String getCryptoKey()

Required. The resource name of the KMS CryptoKey to use for unwrapping. For example, `projects/{project_id}/locations/{location_id}/keyRings/{keyring}/cryptoKeys/{key}`.

Returns:

value or null for none

setCryptoKey

public KmsWrappedCryptoKey setCryptoKey(String cryptoKey)

Required. The resource name of the KMS CryptoKey to use for unwrapping. For example, `projects/{project_id}/locations/{location_id}/keyRings/{keyring}/cryptoKeys/{key}`.

Parameters:

cryptoKey - cryptoKey or null for none

getWrappedKey

public String getWrappedKey()

Required. The wrapped data crypto key.

Returns:

value or null for none

See Also:

decodeWrappedKey()

decodeWrappedKey

public byte[] decodeWrappedKey()

Required. The wrapped data crypto key.

Returns:

Base64 decoded value or null for none

Since:

1.14

See Also:

getWrappedKey()

setWrappedKey

public KmsWrappedCryptoKey setWrappedKey(String wrappedKey)

Required. The wrapped data crypto key.

Parameters:

wrappedKey - wrappedKey or null for none

See Also:

#encodeWrappedKey()

encodeWrappedKey

public KmsWrappedCryptoKey encodeWrappedKey(byte[] wrappedKey)

Required. The wrapped data crypto key.

Since:

1.14

See Also:

The value is encoded Base64 or {@code null} for none.

set

public KmsWrappedCryptoKey set(String fieldName,
                               Object value)

Overrides:

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

clone

public KmsWrappedCryptoKey clone()

Overrides:

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