Package com.google.firestore.admin.v1

Class Database.EncryptionConfig.CustomerManagedEncryptionOptions

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessage

com.google.firestore.admin.v1.Database.EncryptionConfig.CustomerManagedEncryptionOptions

All Implemented Interfaces:

Database.EncryptionConfig.CustomerManagedEncryptionOptionsOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

Enclosing class:

Database.EncryptionConfig

public static final class Database.EncryptionConfig.CustomerManagedEncryptionOptions
extends com.google.protobuf.GeneratedMessage
implements Database.EncryptionConfig.CustomerManagedEncryptionOptionsOrBuilder

 The configuration options for using CMEK (Customer Managed Encryption
 Key) encryption.
 

Protobuf type google.firestore.admin.v1.Database.EncryptionConfig.CustomerManagedEncryptionOptions

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	Database.EncryptionConfig.CustomerManagedEncryptionOptions.Builder	The configuration options for using CMEK (Customer Managed Encryption Key) encryption.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

com.google.protobuf.AbstractMessage.BuilderParent

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field	Description
static final int	KMS_KEY_NAME_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessage

alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
static Database.EncryptionConfig.CustomerManagedEncryptionOptions	getDefaultInstance()
Database.EncryptionConfig.CustomerManagedEncryptionOptions	getDefaultInstanceForType()
static final com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getKmsKeyName()	Required.
com.google.protobuf.ByteString	getKmsKeyNameBytes()	Required.
com.google.protobuf.Parser<Database.EncryptionConfig.CustomerManagedEncryptionOptions>	getParserForType()
int	getSerializedSize()
int	hashCode()
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
final boolean	isInitialized()
static Database.EncryptionConfig.CustomerManagedEncryptionOptions.Builder	newBuilder()
static Database.EncryptionConfig.CustomerManagedEncryptionOptions.Builder	newBuilder(Database.EncryptionConfig.CustomerManagedEncryptionOptions prototype)
Database.EncryptionConfig.CustomerManagedEncryptionOptions.Builder	newBuilderForType()
protected Database.EncryptionConfig.CustomerManagedEncryptionOptions.Builder	newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
static Database.EncryptionConfig.CustomerManagedEncryptionOptions	parseDelimitedFrom(InputStream input)
static Database.EncryptionConfig.CustomerManagedEncryptionOptions	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Database.EncryptionConfig.CustomerManagedEncryptionOptions	parseFrom(byte[] data)
static Database.EncryptionConfig.CustomerManagedEncryptionOptions	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Database.EncryptionConfig.CustomerManagedEncryptionOptions	parseFrom(com.google.protobuf.ByteString data)
static Database.EncryptionConfig.CustomerManagedEncryptionOptions	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Database.EncryptionConfig.CustomerManagedEncryptionOptions	parseFrom(com.google.protobuf.CodedInputStream input)
static Database.EncryptionConfig.CustomerManagedEncryptionOptions	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Database.EncryptionConfig.CustomerManagedEncryptionOptions	parseFrom(InputStream input)
static Database.EncryptionConfig.CustomerManagedEncryptionOptions	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Database.EncryptionConfig.CustomerManagedEncryptionOptions	parseFrom(ByteBuffer data)
static Database.EncryptionConfig.CustomerManagedEncryptionOptions	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Database.EncryptionConfig.CustomerManagedEncryptionOptions>	parser()
Database.EncryptionConfig.CustomerManagedEncryptionOptions.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessage

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashFields, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Field Details

KMS_KEY_NAME_FIELD_NUMBER

public static final int KMS_KEY_NAME_FIELD_NUMBER

See Also:

• Constant Field Values

Method Details

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

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];

Specified by:

getKmsKeyName in interface Database.EncryptionConfig.CustomerManagedEncryptionOptionsOrBuilder

Returns:

The kmsKeyName.

getKmsKeyNameBytes

public com.google.protobuf.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];

Specified by:

getKmsKeyNameBytes in interface Database.EncryptionConfig.CustomerManagedEncryptionOptionsOrBuilder

Returns:

The bytes for kmsKeyName.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessage

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessage

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessage

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static Database.EncryptionConfig.CustomerManagedEncryptionOptions parseFrom(ByteBuffer data)
                                                                            throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Database.EncryptionConfig.CustomerManagedEncryptionOptions parseFrom(ByteBuffer data,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                            throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Database.EncryptionConfig.CustomerManagedEncryptionOptions parseFrom(com.google.protobuf.ByteString data)
                                                                            throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Database.EncryptionConfig.CustomerManagedEncryptionOptions parseFrom(com.google.protobuf.ByteString data,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                            throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Database.EncryptionConfig.CustomerManagedEncryptionOptions parseFrom(byte[] data)
                                                                            throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Database.EncryptionConfig.CustomerManagedEncryptionOptions parseFrom(byte[] data,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                            throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

IOException

parseFrom

public static Database.EncryptionConfig.CustomerManagedEncryptionOptions parseFrom(InputStream input,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                            throws IOException

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseDelimitedFrom

public static Database.EncryptionConfig.CustomerManagedEncryptionOptions parseDelimitedFrom(InputStream input,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                                     throws IOException

Throws:

IOException

parseFrom

public static Database.EncryptionConfig.CustomerManagedEncryptionOptions parseFrom(com.google.protobuf.CodedInputStream input)
                                                                            throws IOException

Throws:

IOException

parseFrom

public static Database.EncryptionConfig.CustomerManagedEncryptionOptions parseFrom(com.google.protobuf.CodedInputStream input,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                            throws IOException

Throws:

IOException

newBuilderForType

public Database.EncryptionConfig.CustomerManagedEncryptionOptions.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

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

newBuilder

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

toBuilder

public Database.EncryptionConfig.CustomerManagedEncryptionOptions.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected Database.EncryptionConfig.CustomerManagedEncryptionOptions.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)

Overrides:

newBuilderForType in class com.google.protobuf.AbstractMessage

getDefaultInstance

public static Database.EncryptionConfig.CustomerManagedEncryptionOptions getDefaultInstance()

parser

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

getParserForType

public com.google.protobuf.Parser<Database.EncryptionConfig.CustomerManagedEncryptionOptions> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessage

getDefaultInstanceForType

public Database.EncryptionConfig.CustomerManagedEncryptionOptions getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder