Send feedback
Class Database.EncryptionConfig.CustomerManagedEncryptionOptions (3.28.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version 3.28.0 keyboard_arrow_down
public static final class Database . EncryptionConfig . CustomerManagedEncryptionOptions extends GeneratedMessageV3 implements Database . EncryptionConfig . CustomerManagedEncryptionOptionsOrBuilder
The configuration options for using CMEK (Customer Managed Encryption
Key) encryption.
Protobuf type
google.firestore.admin.v1.Database.EncryptionConfig.CustomerManagedEncryptionOptions
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
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 . EncryptionConfig . CustomerManagedEncryptionOptions getDefaultInstance ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static Database . EncryptionConfig . CustomerManagedEncryptionOptions . Builder newBuilder ()
newBuilder(Database.EncryptionConfig.CustomerManagedEncryptionOptions prototype)
public static Database . EncryptionConfig . CustomerManagedEncryptionOptions . Builder newBuilder ( Database . EncryptionConfig . CustomerManagedEncryptionOptions prototype )
public static Database . EncryptionConfig . CustomerManagedEncryptionOptions parseDelimitedFrom ( InputStream input )
public static Database . EncryptionConfig . CustomerManagedEncryptionOptions parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static Database . EncryptionConfig . CustomerManagedEncryptionOptions parseFrom ( byte [] data )
Parameter
Name Description
databyte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Database . EncryptionConfig . CustomerManagedEncryptionOptions parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static Database . EncryptionConfig . CustomerManagedEncryptionOptions parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Database . EncryptionConfig . CustomerManagedEncryptionOptions parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static Database . EncryptionConfig . CustomerManagedEncryptionOptions parseFrom ( CodedInputStream input )
public static Database . EncryptionConfig . CustomerManagedEncryptionOptions parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static Database . EncryptionConfig . CustomerManagedEncryptionOptions parseFrom ( InputStream input )
public static Database . EncryptionConfig . CustomerManagedEncryptionOptions parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static Database . EncryptionConfig . CustomerManagedEncryptionOptions parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Database . EncryptionConfig . CustomerManagedEncryptionOptions parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<Database . EncryptionConfig . CustomerManagedEncryptionOptions > parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Name Description
objObject
Overrides
getDefaultInstanceForType()
public Database . EncryptionConfig . CustomerManagedEncryptionOptions getDefaultInstanceForType ()
getKmsKeyName()
public String getKmsKeyName ()
Required. Only keys in the same location as the 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 the 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 . EncryptionConfig . CustomerManagedEncryptionOptions > 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 . EncryptionConfig . CustomerManagedEncryptionOptions . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Database . EncryptionConfig . CustomerManagedEncryptionOptions . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
toBuilder()
public Database . EncryptionConfig . CustomerManagedEncryptionOptions . 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-01-28 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-01-28 UTC."],[],[]]
