Send feedback
Class Database.CmekConfig (3.33.3)
Version latestkeyboard_arrow_down
public static final class Database . CmekConfig extends GeneratedMessageV3 implements Database . CmekConfigOrBuilder
The CMEK (Customer Managed Encryption Key) configuration for a Firestore
database. If not present, the database is secured by the default Google
encryption key.
Protobuf type google.firestore.admin.v1.Database.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
ACTIVE_KEY_VERSION_FIELD_NUMBER
public static final int ACTIVE_KEY_VERSION_FIELD_NUMBER
Field Value
Type Description
int
KMS_KEY_NAME_FIELD_NUMBER
public static final int KMS_KEY_NAME_FIELD_NUMBER
Field Value
Type Description
int
Static Methods
getDefaultInstance()
public static Database . CmekConfig getDefaultInstance ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static Database . CmekConfig . Builder newBuilder ()
newBuilder(Database.CmekConfig prototype)
public static Database . CmekConfig . Builder newBuilder ( Database . CmekConfig prototype )
public static Database . CmekConfig parseDelimitedFrom ( InputStream input )
public static Database . CmekConfig parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static Database . CmekConfig parseFrom ( byte [] data )
Parameter
Name Description
databyte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Database . CmekConfig parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static Database . CmekConfig parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Database . CmekConfig parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static Database . CmekConfig parseFrom ( CodedInputStream input )
public static Database . CmekConfig parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static Database . CmekConfig parseFrom ( InputStream input )
public static Database . CmekConfig parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static Database . CmekConfig parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Database . CmekConfig parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<Database . CmekConfig > parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Name Description
objObject
Overrides
getActiveKeyVersion(int index)
public String getActiveKeyVersion ( int index )
Output only. Currently in-use KMS key
versions .
During key rotation ,
there can be multiple in-use key versions.
The expected format is
projects/{project_id}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{key_version}.
repeated string active_key_version = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter
Name Description
indexint The index of the element to return.
Returns
Type Description
String The activeKeyVersion at the given index.
getActiveKeyVersionBytes(int index)
public ByteString getActiveKeyVersionBytes ( int index )
Output only. Currently in-use KMS key
versions .
During key rotation ,
there can be multiple in-use key versions.
The expected format is
projects/{project_id}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{key_version}.
repeated string active_key_version = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter
Name Description
indexint The index of the value to return.
Returns
Type Description
ByteString The bytes of the activeKeyVersion at the given index.
getActiveKeyVersionCount()
public int getActiveKeyVersionCount ()
Output only. Currently in-use KMS key
versions .
During key rotation ,
there can be multiple in-use key versions.
The expected format is
projects/{project_id}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{key_version}.
repeated string active_key_version = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns
Type Description
int The count of activeKeyVersion.
getActiveKeyVersionList()
public ProtocolStringList getActiveKeyVersionList ()
Output only. Currently in-use KMS key
versions .
During key rotation ,
there can be multiple in-use key versions.
The expected format is
projects/{project_id}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{key_version}.
repeated string active_key_version = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
getDefaultInstanceForType()
public Database . CmekConfig getDefaultInstanceForType ()
getKmsKeyName()
public String getKmsKeyName ()
Required. Only keys in the same location as this database are allowed to
be used for encryption.
For Firestore's nam5 multi-region, this corresponds to Cloud KMS
multi-region us. For Firestore's eur3 multi-region, this corresponds to
Cloud KMS multi-region europe. See
https://cloud.google.com/kms/docs/locations .
The expected format is
projects/{project_id}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}.
string kms_key_name = 1 [(.google.api.field_behavior) = REQUIRED];
Returns
Type Description
String The kmsKeyName.
getKmsKeyNameBytes()
public ByteString getKmsKeyNameBytes ()
Required. Only keys in the same location as this database are allowed to
be used for encryption.
For Firestore's nam5 multi-region, this corresponds to Cloud KMS
multi-region us. For Firestore's eur3 multi-region, this corresponds to
Cloud KMS multi-region europe. See
https://cloud.google.com/kms/docs/locations .
The expected format is
projects/{project_id}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}.
string kms_key_name = 1 [(.google.api.field_behavior) = REQUIRED];
Returns
Type Description
ByteString The bytes for kmsKeyName.
getParserForType()
public Parser<Database . CmekConfig > getParserForType ()
Overrides
getSerializedSize()
public int getSerializedSize ()
Returns
Type Description
int
Overrides
hashCode()
Returns
Type Description
int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public Database . CmekConfig . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Database . CmekConfig . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
toBuilder()
public Database . 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-10-29 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-10-29 UTC."],[],[]]
