Class Database.EncryptionConfig.CustomerManagedEncryptionOptions.Builder (3.30.6)

public static final class Database.EncryptionConfig.CustomerManagedEncryptionOptions.Builder extends GeneratedMessageV3.Builder<Database.EncryptionConfig.CustomerManagedEncryptionOptions.Builder> 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.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Database.EncryptionConfig.CustomerManagedEncryptionOptions.Builder
com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Database.EncryptionConfig.CustomerManagedEncryptionOptions.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Overrides

build()

public Database.EncryptionConfig.CustomerManagedEncryptionOptions build()

buildPartial()

public Database.EncryptionConfig.CustomerManagedEncryptionOptions buildPartial()

clear()

public Database.EncryptionConfig.CustomerManagedEncryptionOptions.Builder clear()
Overrides

clearField(Descriptors.FieldDescriptor field)

public Database.EncryptionConfig.CustomerManagedEncryptionOptions.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Overrides

clearKmsKeyName()

public Database.EncryptionConfig.CustomerManagedEncryptionOptions.Builder clearKmsKeyName()

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
Database.EncryptionConfig.CustomerManagedEncryptionOptions.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Database.EncryptionConfig.CustomerManagedEncryptionOptions.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Overrides

clone()

public Database.EncryptionConfig.CustomerManagedEncryptionOptions.Builder clone()
Overrides

getDefaultInstanceForType()

public Database.EncryptionConfig.CustomerManagedEncryptionOptions getDefaultInstanceForType()

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(Database.EncryptionConfig.CustomerManagedEncryptionOptions other)

public Database.EncryptionConfig.CustomerManagedEncryptionOptions.Builder mergeFrom(Database.EncryptionConfig.CustomerManagedEncryptionOptions other)

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Database.EncryptionConfig.CustomerManagedEncryptionOptions.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Database.EncryptionConfig.CustomerManagedEncryptionOptions.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Database.EncryptionConfig.CustomerManagedEncryptionOptions.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public Database.EncryptionConfig.CustomerManagedEncryptionOptions.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Overrides

setKmsKeyName(String value)

public Database.EncryptionConfig.CustomerManagedEncryptionOptions.Builder setKmsKeyName(String value)

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

Parameter
Name Description
value String

The kmsKeyName to set.

Returns
Type Description
Database.EncryptionConfig.CustomerManagedEncryptionOptions.Builder

This builder for chaining.

setKmsKeyNameBytes(ByteString value)

public Database.EncryptionConfig.CustomerManagedEncryptionOptions.Builder setKmsKeyNameBytes(ByteString value)

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

Parameter
Name Description
value ByteString

The bytes for kmsKeyName to set.

Returns
Type Description
Database.EncryptionConfig.CustomerManagedEncryptionOptions.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Database.EncryptionConfig.CustomerManagedEncryptionOptions.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final Database.EncryptionConfig.CustomerManagedEncryptionOptions.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Overrides