Send feedback
Class CmekConfig (0.60.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version latestkeyboard_arrow_down
public final class CmekConfig extends GeneratedMessageV3 implements CmekConfigOrBuilder
Configurations used to enable CMEK data encryption with Cloud KMS keys.
Protobuf type google.cloud.discoveryengine.v1.CmekConfig
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
IS_DEFAULT_FIELD_NUMBER
public static final int IS_DEFAULT_FIELD_NUMBER
Field Value
Type Description
int
KMS_KEY_FIELD_NUMBER
public static final int KMS_KEY_FIELD_NUMBER
Field Value
Type Description
int
KMS_KEY_VERSION_FIELD_NUMBER
public static final int KMS_KEY_VERSION_FIELD_NUMBER
Field Value
Type Description
int
LAST_ROTATION_TIMESTAMP_MICROS_FIELD_NUMBER
public static final int LAST_ROTATION_TIMESTAMP_MICROS_FIELD_NUMBER
Field Value
Type Description
int
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int
NOTEBOOKLM_STATE_FIELD_NUMBER
public static final int NOTEBOOKLM_STATE_FIELD_NUMBER
Field Value
Type Description
int
SINGLE_REGION_KEYS_FIELD_NUMBER
public static final int SINGLE_REGION_KEYS_FIELD_NUMBER
Field Value
Type Description
int
STATE_FIELD_NUMBER
public static final int STATE_FIELD_NUMBER
Field Value
Type Description
int
Static Methods
getDefaultInstance()
public static CmekConfig getDefaultInstance ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static CmekConfig . Builder newBuilder ()
newBuilder(CmekConfig prototype)
public static CmekConfig . Builder newBuilder ( CmekConfig prototype )
public static CmekConfig parseDelimitedFrom ( InputStream input )
public static CmekConfig parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static CmekConfig parseFrom ( byte [] data )
Parameter
Name Description
databyte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static CmekConfig parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static CmekConfig parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static CmekConfig parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static CmekConfig parseFrom ( CodedInputStream input )
public static CmekConfig parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static CmekConfig parseFrom ( InputStream input )
public static CmekConfig parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static CmekConfig parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static CmekConfig parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<CmekConfig> parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Name Description
objObject
Overrides
getDefaultInstanceForType()
public CmekConfig getDefaultInstanceForType ()
getIsDefault()
public boolean getIsDefault ()
Output only. The default CmekConfig for the Customer.
bool is_default = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns
Type Description
boolean The isDefault.
getKmsKey()
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) = { ... }
Returns
Type Description
String The kmsKey.
getKmsKeyBytes()
public 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) = { ... }
Returns
Type Description
ByteString The bytes for kmsKey.
getKmsKeyVersion()
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) = { ... }
Returns
Type Description
String The kmsKeyVersion.
getKmsKeyVersionBytes()
public 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) = { ... }
Returns
Type Description
ByteString The bytes for kmsKeyVersion.
getLastRotationTimestampMicros()
public long getLastRotationTimestampMicros ()
Output only. The timestamp of the last key rotation.
int64 last_rotation_timestamp_micros = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns
Type Description
long The lastRotationTimestampMicros.
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];
Returns
Type Description
String The name.
getNameBytes()
public 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];
Returns
Type Description
ByteString The bytes for name.
getNotebooklmState()
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];
getNotebooklmStateValue()
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];
Returns
Type Description
int The enum numeric value on the wire for notebooklmState.
getParserForType()
public Parser<CmekConfig> getParserForType ()
Overrides
getSerializedSize()
public int getSerializedSize ()
Returns
Type Description
int
Overrides
getSingleRegionKeys(int index)
public 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];
Parameter
Name Description
indexint
getSingleRegionKeysCount()
public 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];
Returns
Type Description
int
getSingleRegionKeysList()
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];
getSingleRegionKeysOrBuilder(int index)
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];
Parameter
Name Description
indexint
getSingleRegionKeysOrBuilderList()
public 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];
Returns
Type Description
List <? extends com.google.cloud.discoveryengine.v1.SingleRegionKeyOrBuilder >
getState()
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];
getStateValue()
public int getStateValue ()
Output only. The states of the CmekConfig.
.google.cloud.discoveryengine.v1.CmekConfig.State state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns
Type Description
int The enum numeric value on the wire for state.
hashCode()
Returns
Type Description
int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public CmekConfig . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected CmekConfig . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
toBuilder()
public CmekConfig . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-06-12 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-06-12 UTC."],[],[]]
