public static final class CmekConfig.Builder extends com.google.protobuf.GeneratedMessage.Builder<CmekConfig.Builder> implements CmekConfigOrBuilder
Configurations used to enable CMEK data encryption with Cloud KMS keys.Protobuf type
google.cloud.discoveryengine.v1.CmekConfig| Modifier and Type | Method and Description |
|---|---|
CmekConfig.Builder |
addAllSingleRegionKeys(Iterable<? extends SingleRegionKey> values)
Optional.
|
CmekConfig.Builder |
addSingleRegionKeys(int index,
SingleRegionKey.Builder builderForValue)
Optional.
|
CmekConfig.Builder |
addSingleRegionKeys(int index,
SingleRegionKey value)
Optional.
|
CmekConfig.Builder |
addSingleRegionKeys(SingleRegionKey.Builder builderForValue)
Optional.
|
CmekConfig.Builder |
addSingleRegionKeys(SingleRegionKey value)
Optional.
|
SingleRegionKey.Builder |
addSingleRegionKeysBuilder()
Optional.
|
SingleRegionKey.Builder |
addSingleRegionKeysBuilder(int index)
Optional.
|
CmekConfig |
build() |
CmekConfig |
buildPartial() |
CmekConfig.Builder |
clear() |
CmekConfig.Builder |
clearIsDefault()
Output only.
|
CmekConfig.Builder |
clearKmsKey()
KMS key resource name which will be used to encrypt resources
`projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.
|
CmekConfig.Builder |
clearKmsKeyVersion()
KMS key version resource name which will be used to encrypt resources
`<kms_key>/cryptoKeyVersions/{keyVersion}`.
|
CmekConfig.Builder |
clearLastRotationTimestampMicros()
Output only.
|
CmekConfig.Builder |
clearName()
Required.
|
CmekConfig.Builder |
clearNotebooklmState()
Output only.
|
CmekConfig.Builder |
clearSingleRegionKeys()
Optional.
|
CmekConfig.Builder |
clearState()
Output only.
|
CmekConfig |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
com.google.protobuf.Descriptors.Descriptor |
getDescriptorForType() |
boolean |
getIsDefault()
Output only.
|
String |
getKmsKey()
KMS key resource name which will be used to encrypt resources
`projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.
|
com.google.protobuf.ByteString |
getKmsKeyBytes()
KMS key resource name which will be used to encrypt resources
`projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.
|
String |
getKmsKeyVersion()
KMS key version resource name which will be used to encrypt resources
`<kms_key>/cryptoKeyVersions/{keyVersion}`.
|
com.google.protobuf.ByteString |
getKmsKeyVersionBytes()
KMS key version resource name which will be used to encrypt resources
`<kms_key>/cryptoKeyVersions/{keyVersion}`.
|
long |
getLastRotationTimestampMicros()
Output only.
|
String |
getName()
Required.
|
com.google.protobuf.ByteString |
getNameBytes()
Required.
|
CmekConfig.NotebookLMState |
getNotebooklmState()
Output only.
|
int |
getNotebooklmStateValue()
Output only.
|
SingleRegionKey |
getSingleRegionKeys(int index)
Optional.
|
SingleRegionKey.Builder |
getSingleRegionKeysBuilder(int index)
Optional.
|
List<SingleRegionKey.Builder> |
getSingleRegionKeysBuilderList()
Optional.
|
int |
getSingleRegionKeysCount()
Optional.
|
List<SingleRegionKey> |
getSingleRegionKeysList()
Optional.
|
SingleRegionKeyOrBuilder |
getSingleRegionKeysOrBuilder(int index)
Optional.
|
List<? extends SingleRegionKeyOrBuilder> |
getSingleRegionKeysOrBuilderList()
Optional.
|
CmekConfig.State |
getState()
Output only.
|
int |
getStateValue()
Output only.
|
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
CmekConfig.Builder |
mergeFrom(CmekConfig other) |
CmekConfig.Builder |
mergeFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
CmekConfig.Builder |
mergeFrom(com.google.protobuf.Message other) |
CmekConfig.Builder |
removeSingleRegionKeys(int index)
Optional.
|
CmekConfig.Builder |
setIsDefault(boolean value)
Output only.
|
CmekConfig.Builder |
setKmsKey(String value)
KMS key resource name which will be used to encrypt resources
`projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.
|
CmekConfig.Builder |
setKmsKeyBytes(com.google.protobuf.ByteString value)
KMS key resource name which will be used to encrypt resources
`projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.
|
CmekConfig.Builder |
setKmsKeyVersion(String value)
KMS key version resource name which will be used to encrypt resources
`<kms_key>/cryptoKeyVersions/{keyVersion}`.
|
CmekConfig.Builder |
setKmsKeyVersionBytes(com.google.protobuf.ByteString value)
KMS key version resource name which will be used to encrypt resources
`<kms_key>/cryptoKeyVersions/{keyVersion}`.
|
CmekConfig.Builder |
setLastRotationTimestampMicros(long value)
Output only.
|
CmekConfig.Builder |
setName(String value)
Required.
|
CmekConfig.Builder |
setNameBytes(com.google.protobuf.ByteString value)
Required.
|
CmekConfig.Builder |
setNotebooklmState(CmekConfig.NotebookLMState value)
Output only.
|
CmekConfig.Builder |
setNotebooklmStateValue(int value)
Output only.
|
CmekConfig.Builder |
setSingleRegionKeys(int index,
SingleRegionKey.Builder builderForValue)
Optional.
|
CmekConfig.Builder |
setSingleRegionKeys(int index,
SingleRegionKey value)
Optional.
|
CmekConfig.Builder |
setState(CmekConfig.State value)
Output only.
|
CmekConfig.Builder |
setStateValue(int value)
Output only.
|
addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringaddAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitfindInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneofpublic static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<CmekConfig.Builder>public CmekConfig.Builder clear()
clear in interface com.google.protobuf.Message.Builderclear in interface com.google.protobuf.MessageLite.Builderclear in class com.google.protobuf.GeneratedMessage.Builder<CmekConfig.Builder>public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
getDescriptorForType in interface com.google.protobuf.Message.BuildergetDescriptorForType in interface com.google.protobuf.MessageOrBuildergetDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<CmekConfig.Builder>public CmekConfig getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderpublic CmekConfig build()
build in interface com.google.protobuf.Message.Builderbuild in interface com.google.protobuf.MessageLite.Builderpublic CmekConfig buildPartial()
buildPartial in interface com.google.protobuf.Message.BuilderbuildPartial in interface com.google.protobuf.MessageLite.Builderpublic CmekConfig.Builder mergeFrom(com.google.protobuf.Message other)
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<CmekConfig.Builder>public CmekConfig.Builder mergeFrom(CmekConfig other)
public final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessage.Builder<CmekConfig.Builder>public CmekConfig.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in interface com.google.protobuf.MessageLite.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<CmekConfig.Builder>IOExceptionpublic String getName()
Required. The name of the CmekConfig of the form
`projects/{project}/locations/{location}/cmekConfig` or
`projects/{project}/locations/{location}/cmekConfigs/{cmek_config}`.
string name = 1 [(.google.api.field_behavior) = REQUIRED];getName in interface CmekConfigOrBuilderpublic com.google.protobuf.ByteString getNameBytes()
Required. The name of the CmekConfig of the form
`projects/{project}/locations/{location}/cmekConfig` or
`projects/{project}/locations/{location}/cmekConfigs/{cmek_config}`.
string name = 1 [(.google.api.field_behavior) = REQUIRED];getNameBytes in interface CmekConfigOrBuilderpublic CmekConfig.Builder setName(String value)
Required. The name of the CmekConfig of the form
`projects/{project}/locations/{location}/cmekConfig` or
`projects/{project}/locations/{location}/cmekConfigs/{cmek_config}`.
string name = 1 [(.google.api.field_behavior) = REQUIRED];value - The name to set.public CmekConfig.Builder clearName()
Required. The name of the CmekConfig of the form
`projects/{project}/locations/{location}/cmekConfig` or
`projects/{project}/locations/{location}/cmekConfigs/{cmek_config}`.
string name = 1 [(.google.api.field_behavior) = REQUIRED];public CmekConfig.Builder setNameBytes(com.google.protobuf.ByteString value)
Required. The name of the CmekConfig of the form
`projects/{project}/locations/{location}/cmekConfig` or
`projects/{project}/locations/{location}/cmekConfigs/{cmek_config}`.
string name = 1 [(.google.api.field_behavior) = REQUIRED];value - The bytes for name to set.public String getKmsKey()
KMS key resource name which will be used to encrypt resources
`projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.
string kms_key = 2 [(.google.api.resource_reference) = { ... }getKmsKey in interface CmekConfigOrBuilderpublic com.google.protobuf.ByteString getKmsKeyBytes()
KMS key resource name which will be used to encrypt resources
`projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.
string kms_key = 2 [(.google.api.resource_reference) = { ... }getKmsKeyBytes in interface CmekConfigOrBuilderpublic CmekConfig.Builder setKmsKey(String value)
KMS key resource name which will be used to encrypt resources
`projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.
string kms_key = 2 [(.google.api.resource_reference) = { ... }value - The kmsKey to set.public CmekConfig.Builder clearKmsKey()
KMS key resource name which will be used to encrypt resources
`projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.
string kms_key = 2 [(.google.api.resource_reference) = { ... }public CmekConfig.Builder setKmsKeyBytes(com.google.protobuf.ByteString value)
KMS key resource name which will be used to encrypt resources
`projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.
string kms_key = 2 [(.google.api.resource_reference) = { ... }value - The bytes for kmsKey to set.public String getKmsKeyVersion()
KMS key version resource name which will be used to encrypt resources
`<kms_key>/cryptoKeyVersions/{keyVersion}`.
string kms_key_version = 6 [(.google.api.resource_reference) = { ... }getKmsKeyVersion in interface CmekConfigOrBuilderpublic com.google.protobuf.ByteString getKmsKeyVersionBytes()
KMS key version resource name which will be used to encrypt resources
`<kms_key>/cryptoKeyVersions/{keyVersion}`.
string kms_key_version = 6 [(.google.api.resource_reference) = { ... }getKmsKeyVersionBytes in interface CmekConfigOrBuilderpublic CmekConfig.Builder setKmsKeyVersion(String value)
KMS key version resource name which will be used to encrypt resources
`<kms_key>/cryptoKeyVersions/{keyVersion}`.
string kms_key_version = 6 [(.google.api.resource_reference) = { ... }value - The kmsKeyVersion to set.public CmekConfig.Builder clearKmsKeyVersion()
KMS key version resource name which will be used to encrypt resources
`<kms_key>/cryptoKeyVersions/{keyVersion}`.
string kms_key_version = 6 [(.google.api.resource_reference) = { ... }public CmekConfig.Builder setKmsKeyVersionBytes(com.google.protobuf.ByteString value)
KMS key version resource name which will be used to encrypt resources
`<kms_key>/cryptoKeyVersions/{keyVersion}`.
string kms_key_version = 6 [(.google.api.resource_reference) = { ... }value - The bytes for kmsKeyVersion to set.public int getStateValue()
Output only. The states of the CmekConfig.
.google.cloud.discoveryengine.v1.CmekConfig.State state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
getStateValue in interface CmekConfigOrBuilderpublic CmekConfig.Builder setStateValue(int value)
Output only. The states of the CmekConfig.
.google.cloud.discoveryengine.v1.CmekConfig.State state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
value - The enum numeric value on the wire for state to set.public CmekConfig.State getState()
Output only. The states of the CmekConfig.
.google.cloud.discoveryengine.v1.CmekConfig.State state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
getState in interface CmekConfigOrBuilderpublic CmekConfig.Builder setState(CmekConfig.State value)
Output only. The states of the CmekConfig.
.google.cloud.discoveryengine.v1.CmekConfig.State state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
value - The state to set.public CmekConfig.Builder clearState()
Output only. The states of the CmekConfig.
.google.cloud.discoveryengine.v1.CmekConfig.State state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
public boolean getIsDefault()
Output only. The default CmekConfig for the Customer.
bool is_default = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];getIsDefault in interface CmekConfigOrBuilderpublic CmekConfig.Builder setIsDefault(boolean value)
Output only. The default CmekConfig for the Customer.
bool is_default = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];value - The isDefault to set.public CmekConfig.Builder clearIsDefault()
Output only. The default CmekConfig for the Customer.
bool is_default = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];public long getLastRotationTimestampMicros()
Output only. The timestamp of the last key rotation.
int64 last_rotation_timestamp_micros = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
getLastRotationTimestampMicros in interface CmekConfigOrBuilderpublic CmekConfig.Builder setLastRotationTimestampMicros(long value)
Output only. The timestamp of the last key rotation.
int64 last_rotation_timestamp_micros = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
value - The lastRotationTimestampMicros to set.public CmekConfig.Builder clearLastRotationTimestampMicros()
Output only. The timestamp of the last key rotation.
int64 last_rotation_timestamp_micros = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
public List<SingleRegionKey> getSingleRegionKeysList()
Optional. Single-regional CMEKs that are required for some VAIS features.
repeated .google.cloud.discoveryengine.v1.SingleRegionKey single_region_keys = 7 [(.google.api.field_behavior) = OPTIONAL];
getSingleRegionKeysList in interface CmekConfigOrBuilderpublic int getSingleRegionKeysCount()
Optional. Single-regional CMEKs that are required for some VAIS features.
repeated .google.cloud.discoveryengine.v1.SingleRegionKey single_region_keys = 7 [(.google.api.field_behavior) = OPTIONAL];
getSingleRegionKeysCount in interface CmekConfigOrBuilderpublic SingleRegionKey getSingleRegionKeys(int index)
Optional. Single-regional CMEKs that are required for some VAIS features.
repeated .google.cloud.discoveryengine.v1.SingleRegionKey single_region_keys = 7 [(.google.api.field_behavior) = OPTIONAL];
getSingleRegionKeys in interface CmekConfigOrBuilderpublic CmekConfig.Builder setSingleRegionKeys(int index, SingleRegionKey value)
Optional. Single-regional CMEKs that are required for some VAIS features.
repeated .google.cloud.discoveryengine.v1.SingleRegionKey single_region_keys = 7 [(.google.api.field_behavior) = OPTIONAL];
public CmekConfig.Builder setSingleRegionKeys(int index, SingleRegionKey.Builder builderForValue)
Optional. Single-regional CMEKs that are required for some VAIS features.
repeated .google.cloud.discoveryengine.v1.SingleRegionKey single_region_keys = 7 [(.google.api.field_behavior) = OPTIONAL];
public CmekConfig.Builder addSingleRegionKeys(SingleRegionKey value)
Optional. Single-regional CMEKs that are required for some VAIS features.
repeated .google.cloud.discoveryengine.v1.SingleRegionKey single_region_keys = 7 [(.google.api.field_behavior) = OPTIONAL];
public CmekConfig.Builder addSingleRegionKeys(int index, SingleRegionKey value)
Optional. Single-regional CMEKs that are required for some VAIS features.
repeated .google.cloud.discoveryengine.v1.SingleRegionKey single_region_keys = 7 [(.google.api.field_behavior) = OPTIONAL];
public CmekConfig.Builder addSingleRegionKeys(SingleRegionKey.Builder builderForValue)
Optional. Single-regional CMEKs that are required for some VAIS features.
repeated .google.cloud.discoveryengine.v1.SingleRegionKey single_region_keys = 7 [(.google.api.field_behavior) = OPTIONAL];
public CmekConfig.Builder addSingleRegionKeys(int index, SingleRegionKey.Builder builderForValue)
Optional. Single-regional CMEKs that are required for some VAIS features.
repeated .google.cloud.discoveryengine.v1.SingleRegionKey single_region_keys = 7 [(.google.api.field_behavior) = OPTIONAL];
public CmekConfig.Builder addAllSingleRegionKeys(Iterable<? extends SingleRegionKey> values)
Optional. Single-regional CMEKs that are required for some VAIS features.
repeated .google.cloud.discoveryengine.v1.SingleRegionKey single_region_keys = 7 [(.google.api.field_behavior) = OPTIONAL];
public CmekConfig.Builder clearSingleRegionKeys()
Optional. Single-regional CMEKs that are required for some VAIS features.
repeated .google.cloud.discoveryengine.v1.SingleRegionKey single_region_keys = 7 [(.google.api.field_behavior) = OPTIONAL];
public CmekConfig.Builder removeSingleRegionKeys(int index)
Optional. Single-regional CMEKs that are required for some VAIS features.
repeated .google.cloud.discoveryengine.v1.SingleRegionKey single_region_keys = 7 [(.google.api.field_behavior) = OPTIONAL];
public SingleRegionKey.Builder getSingleRegionKeysBuilder(int index)
Optional. Single-regional CMEKs that are required for some VAIS features.
repeated .google.cloud.discoveryengine.v1.SingleRegionKey single_region_keys = 7 [(.google.api.field_behavior) = OPTIONAL];
public SingleRegionKeyOrBuilder getSingleRegionKeysOrBuilder(int index)
Optional. Single-regional CMEKs that are required for some VAIS features.
repeated .google.cloud.discoveryengine.v1.SingleRegionKey single_region_keys = 7 [(.google.api.field_behavior) = OPTIONAL];
getSingleRegionKeysOrBuilder in interface CmekConfigOrBuilderpublic List<? extends SingleRegionKeyOrBuilder> getSingleRegionKeysOrBuilderList()
Optional. Single-regional CMEKs that are required for some VAIS features.
repeated .google.cloud.discoveryengine.v1.SingleRegionKey single_region_keys = 7 [(.google.api.field_behavior) = OPTIONAL];
getSingleRegionKeysOrBuilderList in interface CmekConfigOrBuilderpublic SingleRegionKey.Builder addSingleRegionKeysBuilder()
Optional. Single-regional CMEKs that are required for some VAIS features.
repeated .google.cloud.discoveryengine.v1.SingleRegionKey single_region_keys = 7 [(.google.api.field_behavior) = OPTIONAL];
public SingleRegionKey.Builder addSingleRegionKeysBuilder(int index)
Optional. Single-regional CMEKs that are required for some VAIS features.
repeated .google.cloud.discoveryengine.v1.SingleRegionKey single_region_keys = 7 [(.google.api.field_behavior) = OPTIONAL];
public List<SingleRegionKey.Builder> getSingleRegionKeysBuilderList()
Optional. Single-regional CMEKs that are required for some VAIS features.
repeated .google.cloud.discoveryengine.v1.SingleRegionKey single_region_keys = 7 [(.google.api.field_behavior) = OPTIONAL];
public int getNotebooklmStateValue()
Output only. Whether the NotebookLM Corpus is ready to be used.
.google.cloud.discoveryengine.v1.CmekConfig.NotebookLMState notebooklm_state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
getNotebooklmStateValue in interface CmekConfigOrBuilderpublic CmekConfig.Builder setNotebooklmStateValue(int value)
Output only. Whether the NotebookLM Corpus is ready to be used.
.google.cloud.discoveryengine.v1.CmekConfig.NotebookLMState notebooklm_state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
value - The enum numeric value on the wire for notebooklmState to set.public CmekConfig.NotebookLMState getNotebooklmState()
Output only. Whether the NotebookLM Corpus is ready to be used.
.google.cloud.discoveryengine.v1.CmekConfig.NotebookLMState notebooklm_state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
getNotebooklmState in interface CmekConfigOrBuilderpublic CmekConfig.Builder setNotebooklmState(CmekConfig.NotebookLMState value)
Output only. Whether the NotebookLM Corpus is ready to be used.
.google.cloud.discoveryengine.v1.CmekConfig.NotebookLMState notebooklm_state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
value - The notebooklmState to set.public CmekConfig.Builder clearNotebooklmState()
Output only. Whether the NotebookLM Corpus is ready to be used.
.google.cloud.discoveryengine.v1.CmekConfig.NotebookLMState notebooklm_state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
Copyright © 2026 Google LLC. All rights reserved.