com.google.api.services.discoveryengine.v1.model

Class GoogleCloudDiscoveryengineV1CmekConfig

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.discoveryengine.v1.model.GoogleCloudDiscoveryengineV1CmekConfig

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

Configurations used to enable CMEK data encryption with Cloud KMS keys.

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 Discovery Engine 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
GoogleCloudDiscoveryengineV1CmekConfig()

Method Summary

Modifier and Type	Method and Description
GoogleCloudDiscoveryengineV1CmekConfig	clone()
Boolean	getIsDefault() Output only.
String	getKmsKey() Required.
String	getKmsKeyVersion() Output only.
Long	getLastRotationTimestampMicros() Output only.
String	getName() Required.
String	getNotebooklmState() Output only.
List<GoogleCloudDiscoveryengineV1SingleRegionKey>	getSingleRegionKeys() Optional.
String	getState() Output only.
GoogleCloudDiscoveryengineV1CmekConfig	set(String fieldName, Object value)
GoogleCloudDiscoveryengineV1CmekConfig	setIsDefault(Boolean isDefault) Output only.
GoogleCloudDiscoveryengineV1CmekConfig	setKmsKey(String kmsKey) Required.
GoogleCloudDiscoveryengineV1CmekConfig	setKmsKeyVersion(String kmsKeyVersion) Output only.
GoogleCloudDiscoveryengineV1CmekConfig	setLastRotationTimestampMicros(Long lastRotationTimestampMicros) Output only.
GoogleCloudDiscoveryengineV1CmekConfig	setName(String name) Required.
GoogleCloudDiscoveryengineV1CmekConfig	setNotebooklmState(String notebooklmState) Output only.
GoogleCloudDiscoveryengineV1CmekConfig	setSingleRegionKeys(List<GoogleCloudDiscoveryengineV1SingleRegionKey> singleRegionKeys) Optional.
GoogleCloudDiscoveryengineV1CmekConfig	setState(String state) Output only.

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

GoogleCloudDiscoveryengineV1CmekConfig

public GoogleCloudDiscoveryengineV1CmekConfig()

Method Detail

getIsDefault

public Boolean getIsDefault()

Output only. The default CmekConfig for the Customer.

Returns:

value or null for none

setIsDefault

public GoogleCloudDiscoveryengineV1CmekConfig setIsDefault(Boolean isDefault)

Output only. The default CmekConfig for the Customer.

Parameters:

isDefault - isDefault or null for none

getKmsKey

public String getKmsKey()

Required. KMS key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.

Returns:

value or null for none

setKmsKey

public GoogleCloudDiscoveryengineV1CmekConfig setKmsKey(String kmsKey)

Required. KMS key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.

Parameters:

kmsKey - kmsKey or null for none

getKmsKeyVersion

public String getKmsKeyVersion()

Output only. KMS key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`.

Returns:

value or null for none

setKmsKeyVersion

public GoogleCloudDiscoveryengineV1CmekConfig setKmsKeyVersion(String kmsKeyVersion)

Output only. KMS key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`.

Parameters:

kmsKeyVersion - kmsKeyVersion or null for none

getLastRotationTimestampMicros

public Long getLastRotationTimestampMicros()

Output only. The timestamp of the last key rotation.

Returns:

value or null for none

setLastRotationTimestampMicros

public GoogleCloudDiscoveryengineV1CmekConfig setLastRotationTimestampMicros(Long lastRotationTimestampMicros)

Output only. The timestamp of the last key rotation.

Parameters:

lastRotationTimestampMicros - lastRotationTimestampMicros or null for none

getName

public String getName()

Required. The name of the CmekConfig of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmek_config}`.

Returns:

value or null for none

setName

public GoogleCloudDiscoveryengineV1CmekConfig setName(String name)

Required. The name of the CmekConfig of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmek_config}`.

Parameters:

name - name or null for none

getNotebooklmState

public String getNotebooklmState()

Output only. Whether the NotebookLM Corpus is ready to be used.

Returns:

value or null for none

setNotebooklmState

public GoogleCloudDiscoveryengineV1CmekConfig setNotebooklmState(String notebooklmState)

Output only. Whether the NotebookLM Corpus is ready to be used.

Parameters:

notebooklmState - notebooklmState or null for none

getSingleRegionKeys

public List<GoogleCloudDiscoveryengineV1SingleRegionKey> getSingleRegionKeys()

Optional. Single-regional CMEKs that are required for some VAIS features.

Returns:

value or null for none

setSingleRegionKeys

public GoogleCloudDiscoveryengineV1CmekConfig setSingleRegionKeys(List<GoogleCloudDiscoveryengineV1SingleRegionKey> singleRegionKeys)

Optional. Single-regional CMEKs that are required for some VAIS features.

Parameters:

singleRegionKeys - singleRegionKeys or null for none

getState

public String getState()

Output only. The states of the CmekConfig.

Returns:

value or null for none

setState

public GoogleCloudDiscoveryengineV1CmekConfig setState(String state)

Output only. The states of the CmekConfig.

Parameters:

state - state or null for none

set

public GoogleCloudDiscoveryengineV1CmekConfig set(String fieldName,
                                                  Object value)

Overrides:

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

clone

public GoogleCloudDiscoveryengineV1CmekConfig clone()

Overrides:

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