Class Database.EncryptionConfig.CustomerManagedEncryptionOptions (3.26.5)

Version 3.26.5

• 3.30.2 (latest)
• 3.30.0
• 3.28.0
• 3.27.2
• 3.26.5
• 3.25.1
• 3.24.3
• 3.22.0
• 3.21.4
• 3.20.0
• 3.17.0
• 3.16.3
• 3.15.7
• 3.14.4
• 3.13.2
• 3.12.1
• 3.11.0
• 3.10.0
• 3.9.6
• 3.8.2
• 3.7.10
• 3.6.0
• 3.5.0
• 3.4.2
• 3.3.0
• 3.2.0
• 3.1.0
• 3.0.21

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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Database.EncryptionConfig.CustomerManagedEncryptionOptions

Implements

Database.EncryptionConfig.CustomerManagedEncryptionOptionsOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,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()

Returns
Type	Description
Database.EncryptionConfig.CustomerManagedEncryptionOptions

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static Database.EncryptionConfig.CustomerManagedEncryptionOptions.Builder newBuilder()

Returns
Type	Description
Database.EncryptionConfig.CustomerManagedEncryptionOptions.Builder

newBuilder(Database.EncryptionConfig.CustomerManagedEncryptionOptions prototype)

public static Database.EncryptionConfig.CustomerManagedEncryptionOptions.Builder newBuilder(Database.EncryptionConfig.CustomerManagedEncryptionOptions prototype)

Parameter
Name	Description
prototype	Database.EncryptionConfig.CustomerManagedEncryptionOptions

Returns
Type	Description
Database.EncryptionConfig.CustomerManagedEncryptionOptions.Builder

parseDelimitedFrom(InputStream input)

public static Database.EncryptionConfig.CustomerManagedEncryptionOptions parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
Database.EncryptionConfig.CustomerManagedEncryptionOptions

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Database.EncryptionConfig.CustomerManagedEncryptionOptions parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Database.EncryptionConfig.CustomerManagedEncryptionOptions

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static Database.EncryptionConfig.CustomerManagedEncryptionOptions parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
Database.EncryptionConfig.CustomerManagedEncryptionOptions

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Database.EncryptionConfig.CustomerManagedEncryptionOptions parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Database.EncryptionConfig.CustomerManagedEncryptionOptions

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Database.EncryptionConfig.CustomerManagedEncryptionOptions parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
Database.EncryptionConfig.CustomerManagedEncryptionOptions

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Database.EncryptionConfig.CustomerManagedEncryptionOptions parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Database.EncryptionConfig.CustomerManagedEncryptionOptions

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Database.EncryptionConfig.CustomerManagedEncryptionOptions parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
Database.EncryptionConfig.CustomerManagedEncryptionOptions

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Database.EncryptionConfig.CustomerManagedEncryptionOptions parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Database.EncryptionConfig.CustomerManagedEncryptionOptions

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static Database.EncryptionConfig.CustomerManagedEncryptionOptions parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
Database.EncryptionConfig.CustomerManagedEncryptionOptions

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Database.EncryptionConfig.CustomerManagedEncryptionOptions parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Database.EncryptionConfig.CustomerManagedEncryptionOptions

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static Database.EncryptionConfig.CustomerManagedEncryptionOptions parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
Database.EncryptionConfig.CustomerManagedEncryptionOptions

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Database.EncryptionConfig.CustomerManagedEncryptionOptions parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Database.EncryptionConfig.CustomerManagedEncryptionOptions

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<Database.EncryptionConfig.CustomerManagedEncryptionOptions> parser()

Returns
Type	Description
Parser<CustomerManagedEncryptionOptions>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getDefaultInstanceForType()

public Database.EncryptionConfig.CustomerManagedEncryptionOptions getDefaultInstanceForType()

Returns
Type	Description
Database.EncryptionConfig.CustomerManagedEncryptionOptions

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()

Returns
Type	Description
Parser<CustomerManagedEncryptionOptions>

Overrides

GeneratedMessageV3.getParserForType()

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public Database.EncryptionConfig.CustomerManagedEncryptionOptions.Builder newBuilderForType()

Returns
Type	Description
Database.EncryptionConfig.CustomerManagedEncryptionOptions.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Database.EncryptionConfig.CustomerManagedEncryptionOptions.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
Database.EncryptionConfig.CustomerManagedEncryptionOptions.Builder

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
unused	UnusedPrivateParameter

Returns
Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public Database.EncryptionConfig.CustomerManagedEncryptionOptions.Builder toBuilder()

Returns
Type	Description
Database.EncryptionConfig.CustomerManagedEncryptionOptions.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException