com.google.api.services.spanner.v1.model

Class InstanceEncryptionConfig

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.spanner.v1.model.InstanceEncryptionConfig

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

Encryption configuration for a Cloud Spanner database.

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 Spanner 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
InstanceEncryptionConfig()

Method Summary

Modifier and Type	Method and Description
InstanceEncryptionConfig	clone()
String	getKmsKeyName() Optional.
List<String>	getKmsKeyNames() Optional.
InstanceEncryptionConfig	set(String fieldName, Object value)
InstanceEncryptionConfig	setKmsKeyName(String kmsKeyName) Optional.
InstanceEncryptionConfig	setKmsKeyNames(List<String> kmsKeyNames) Optional.

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

InstanceEncryptionConfig

public InstanceEncryptionConfig()

Method Detail

getKmsKeyName

public String getKmsKeyName()

Optional. This field is maintained for backwards compatibility. For new callers, we recommend using `kms_key_names` to specify the KMS key. `kms_key_name` should only be used if the location of the KMS key matches the database instance’s configuration (location) exactly. E.g. The KMS location is in us-central1 or nam3 and the database instance is also in us-central1 or nam3. The Cloud KMS key to be used for encrypting and decrypting the database. Values are of the form `projects//locations//keyRings//cryptoKeys/`.

Returns:

value or null for none

setKmsKeyName

public InstanceEncryptionConfig setKmsKeyName(String kmsKeyName)

Optional. This field is maintained for backwards compatibility. For new callers, we recommend using `kms_key_names` to specify the KMS key. `kms_key_name` should only be used if the location of the KMS key matches the database instance’s configuration (location) exactly. E.g. The KMS location is in us-central1 or nam3 and the database instance is also in us-central1 or nam3. The Cloud KMS key to be used for encrypting and decrypting the database. Values are of the form `projects//locations//keyRings//cryptoKeys/`.

Parameters:

kmsKeyName - kmsKeyName or null for none

getKmsKeyNames

public List<String> getKmsKeyNames()

Optional. Specifies the KMS configuration for one or more keys used to encrypt the database. Values are of the form `projects//locations//keyRings//cryptoKeys/`. The keys referenced by `kms_key_names` must fully cover all regions of the database's instance configuration. Some examples: * For regional (single-region) instance configurations, specify a regional location KMS key. * For multi-region instance configurations of type `GOOGLE_MANAGED`, either specify a multi-region location KMS key or multiple regional location KMS keys that cover all regions in the instance configuration. * For an instance configuration of type `USER_MANAGED`, specify only regional location KMS keys to cover each region in the instance configuration. Multi- region location KMS keys aren't supported for `USER_MANAGED` type instance configurations.

Returns:

value or null for none

setKmsKeyNames

public InstanceEncryptionConfig setKmsKeyNames(List<String> kmsKeyNames)

Optional. Specifies the KMS configuration for one or more keys used to encrypt the database. Values are of the form `projects//locations//keyRings//cryptoKeys/`. The keys referenced by `kms_key_names` must fully cover all regions of the database's instance configuration. Some examples: * For regional (single-region) instance configurations, specify a regional location KMS key. * For multi-region instance configurations of type `GOOGLE_MANAGED`, either specify a multi-region location KMS key or multiple regional location KMS keys that cover all regions in the instance configuration. * For an instance configuration of type `USER_MANAGED`, specify only regional location KMS keys to cover each region in the instance configuration. Multi- region location KMS keys aren't supported for `USER_MANAGED` type instance configurations.

Parameters:

kmsKeyNames - kmsKeyNames or null for none

set

public InstanceEncryptionConfig set(String fieldName,
                                    Object value)

Overrides:

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

clone

public InstanceEncryptionConfig clone()

Overrides:

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