Class Database.EncryptionConfig.Builder (3.30.0)

public static final class Database.EncryptionConfig.Builder extends GeneratedMessageV3.Builder<Database.EncryptionConfig.Builder> implements Database.EncryptionConfigOrBuilder

Encryption configuration for a new database being created from another source.

The source could be a Backup .

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

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public Database.EncryptionConfig build()
Returns
Type Description
Database.EncryptionConfig

buildPartial()

public Database.EncryptionConfig buildPartial()
Returns
Type Description
Database.EncryptionConfig

clear()

public Database.EncryptionConfig.Builder clear()
Returns
Type Description
Database.EncryptionConfig.Builder
Overrides

clearCustomerManagedEncryption()

public Database.EncryptionConfig.Builder clearCustomerManagedEncryption()

Use Customer Managed Encryption Keys (CMEK) for encryption.

.google.firestore.admin.v1.Database.EncryptionConfig.CustomerManagedEncryptionOptions customer_managed_encryption = 3;

Returns
Type Description
Database.EncryptionConfig.Builder

clearEncryptionType()

public Database.EncryptionConfig.Builder clearEncryptionType()
Returns
Type Description
Database.EncryptionConfig.Builder

clearField(Descriptors.FieldDescriptor field)

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

clearGoogleDefaultEncryption()

public Database.EncryptionConfig.Builder clearGoogleDefaultEncryption()

Use Google default encryption.

.google.firestore.admin.v1.Database.EncryptionConfig.GoogleDefaultEncryptionOptions google_default_encryption = 1;

Returns
Type Description
Database.EncryptionConfig.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearUseSourceEncryption()

public Database.EncryptionConfig.Builder clearUseSourceEncryption()

The database will use the same encryption configuration as the source.

.google.firestore.admin.v1.Database.EncryptionConfig.SourceEncryptionOptions use_source_encryption = 2;

Returns
Type Description
Database.EncryptionConfig.Builder

clone()

public Database.EncryptionConfig.Builder clone()
Returns
Type Description
Database.EncryptionConfig.Builder
Overrides

getCustomerManagedEncryption()

public Database.EncryptionConfig.CustomerManagedEncryptionOptions getCustomerManagedEncryption()

Use Customer Managed Encryption Keys (CMEK) for encryption.

.google.firestore.admin.v1.Database.EncryptionConfig.CustomerManagedEncryptionOptions customer_managed_encryption = 3;

Returns
Type Description
Database.EncryptionConfig.CustomerManagedEncryptionOptions

The customerManagedEncryption.

getCustomerManagedEncryptionBuilder()

public Database.EncryptionConfig.CustomerManagedEncryptionOptions.Builder getCustomerManagedEncryptionBuilder()

Use Customer Managed Encryption Keys (CMEK) for encryption.

.google.firestore.admin.v1.Database.EncryptionConfig.CustomerManagedEncryptionOptions customer_managed_encryption = 3;

Returns
Type Description
Database.EncryptionConfig.CustomerManagedEncryptionOptions.Builder

getCustomerManagedEncryptionOrBuilder()

public Database.EncryptionConfig.CustomerManagedEncryptionOptionsOrBuilder getCustomerManagedEncryptionOrBuilder()

Use Customer Managed Encryption Keys (CMEK) for encryption.

.google.firestore.admin.v1.Database.EncryptionConfig.CustomerManagedEncryptionOptions customer_managed_encryption = 3;

Returns
Type Description
Database.EncryptionConfig.CustomerManagedEncryptionOptionsOrBuilder

getDefaultInstanceForType()

public Database.EncryptionConfig getDefaultInstanceForType()
Returns
Type Description
Database.EncryptionConfig

getDescriptorForType()

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

getEncryptionTypeCase()

public Database.EncryptionConfig.EncryptionTypeCase getEncryptionTypeCase()
Returns
Type Description
Database.EncryptionConfig.EncryptionTypeCase

getGoogleDefaultEncryption()

public Database.EncryptionConfig.GoogleDefaultEncryptionOptions getGoogleDefaultEncryption()

Use Google default encryption.

.google.firestore.admin.v1.Database.EncryptionConfig.GoogleDefaultEncryptionOptions google_default_encryption = 1;

Returns
Type Description
Database.EncryptionConfig.GoogleDefaultEncryptionOptions

The googleDefaultEncryption.

getGoogleDefaultEncryptionBuilder()

public Database.EncryptionConfig.GoogleDefaultEncryptionOptions.Builder getGoogleDefaultEncryptionBuilder()

Use Google default encryption.

.google.firestore.admin.v1.Database.EncryptionConfig.GoogleDefaultEncryptionOptions google_default_encryption = 1;

Returns
Type Description
Database.EncryptionConfig.GoogleDefaultEncryptionOptions.Builder

getGoogleDefaultEncryptionOrBuilder()

public Database.EncryptionConfig.GoogleDefaultEncryptionOptionsOrBuilder getGoogleDefaultEncryptionOrBuilder()

Use Google default encryption.

.google.firestore.admin.v1.Database.EncryptionConfig.GoogleDefaultEncryptionOptions google_default_encryption = 1;

Returns
Type Description
Database.EncryptionConfig.GoogleDefaultEncryptionOptionsOrBuilder

getUseSourceEncryption()

public Database.EncryptionConfig.SourceEncryptionOptions getUseSourceEncryption()

The database will use the same encryption configuration as the source.

.google.firestore.admin.v1.Database.EncryptionConfig.SourceEncryptionOptions use_source_encryption = 2;

Returns
Type Description
Database.EncryptionConfig.SourceEncryptionOptions

The useSourceEncryption.

getUseSourceEncryptionBuilder()

public Database.EncryptionConfig.SourceEncryptionOptions.Builder getUseSourceEncryptionBuilder()

The database will use the same encryption configuration as the source.

.google.firestore.admin.v1.Database.EncryptionConfig.SourceEncryptionOptions use_source_encryption = 2;

Returns
Type Description
Database.EncryptionConfig.SourceEncryptionOptions.Builder

getUseSourceEncryptionOrBuilder()

public Database.EncryptionConfig.SourceEncryptionOptionsOrBuilder getUseSourceEncryptionOrBuilder()

The database will use the same encryption configuration as the source.

.google.firestore.admin.v1.Database.EncryptionConfig.SourceEncryptionOptions use_source_encryption = 2;

Returns
Type Description
Database.EncryptionConfig.SourceEncryptionOptionsOrBuilder

hasCustomerManagedEncryption()

public boolean hasCustomerManagedEncryption()

Use Customer Managed Encryption Keys (CMEK) for encryption.

.google.firestore.admin.v1.Database.EncryptionConfig.CustomerManagedEncryptionOptions customer_managed_encryption = 3;

Returns
Type Description
boolean

Whether the customerManagedEncryption field is set.

hasGoogleDefaultEncryption()

public boolean hasGoogleDefaultEncryption()

Use Google default encryption.

.google.firestore.admin.v1.Database.EncryptionConfig.GoogleDefaultEncryptionOptions google_default_encryption = 1;

Returns
Type Description
boolean

Whether the googleDefaultEncryption field is set.

hasUseSourceEncryption()

public boolean hasUseSourceEncryption()

The database will use the same encryption configuration as the source.

.google.firestore.admin.v1.Database.EncryptionConfig.SourceEncryptionOptions use_source_encryption = 2;

Returns
Type Description
boolean

Whether the useSourceEncryption field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCustomerManagedEncryption(Database.EncryptionConfig.CustomerManagedEncryptionOptions value)

public Database.EncryptionConfig.Builder mergeCustomerManagedEncryption(Database.EncryptionConfig.CustomerManagedEncryptionOptions value)

Use Customer Managed Encryption Keys (CMEK) for encryption.

.google.firestore.admin.v1.Database.EncryptionConfig.CustomerManagedEncryptionOptions customer_managed_encryption = 3;

Parameter
Name Description
value Database.EncryptionConfig.CustomerManagedEncryptionOptions
Returns
Type Description
Database.EncryptionConfig.Builder

mergeFrom(Database.EncryptionConfig other)

public Database.EncryptionConfig.Builder mergeFrom(Database.EncryptionConfig other)
Parameter
Name Description
other Database.EncryptionConfig
Returns
Type Description
Database.EncryptionConfig.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeGoogleDefaultEncryption(Database.EncryptionConfig.GoogleDefaultEncryptionOptions value)

public Database.EncryptionConfig.Builder mergeGoogleDefaultEncryption(Database.EncryptionConfig.GoogleDefaultEncryptionOptions value)

Use Google default encryption.

.google.firestore.admin.v1.Database.EncryptionConfig.GoogleDefaultEncryptionOptions google_default_encryption = 1;

Parameter
Name Description
value Database.EncryptionConfig.GoogleDefaultEncryptionOptions
Returns
Type Description
Database.EncryptionConfig.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

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

mergeUseSourceEncryption(Database.EncryptionConfig.SourceEncryptionOptions value)

public Database.EncryptionConfig.Builder mergeUseSourceEncryption(Database.EncryptionConfig.SourceEncryptionOptions value)

The database will use the same encryption configuration as the source.

.google.firestore.admin.v1.Database.EncryptionConfig.SourceEncryptionOptions use_source_encryption = 2;

Parameter
Name Description
value Database.EncryptionConfig.SourceEncryptionOptions
Returns
Type Description
Database.EncryptionConfig.Builder

setCustomerManagedEncryption(Database.EncryptionConfig.CustomerManagedEncryptionOptions value)

public Database.EncryptionConfig.Builder setCustomerManagedEncryption(Database.EncryptionConfig.CustomerManagedEncryptionOptions value)

Use Customer Managed Encryption Keys (CMEK) for encryption.

.google.firestore.admin.v1.Database.EncryptionConfig.CustomerManagedEncryptionOptions customer_managed_encryption = 3;

Parameter
Name Description
value Database.EncryptionConfig.CustomerManagedEncryptionOptions
Returns
Type Description
Database.EncryptionConfig.Builder

setCustomerManagedEncryption(Database.EncryptionConfig.CustomerManagedEncryptionOptions.Builder builderForValue)

public Database.EncryptionConfig.Builder setCustomerManagedEncryption(Database.EncryptionConfig.CustomerManagedEncryptionOptions.Builder builderForValue)

Use Customer Managed Encryption Keys (CMEK) for encryption.

.google.firestore.admin.v1.Database.EncryptionConfig.CustomerManagedEncryptionOptions customer_managed_encryption = 3;

Parameter
Name Description
builderForValue Database.EncryptionConfig.CustomerManagedEncryptionOptions.Builder
Returns
Type Description
Database.EncryptionConfig.Builder

setField(Descriptors.FieldDescriptor field, Object value)

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

setGoogleDefaultEncryption(Database.EncryptionConfig.GoogleDefaultEncryptionOptions value)

public Database.EncryptionConfig.Builder setGoogleDefaultEncryption(Database.EncryptionConfig.GoogleDefaultEncryptionOptions value)

Use Google default encryption.

.google.firestore.admin.v1.Database.EncryptionConfig.GoogleDefaultEncryptionOptions google_default_encryption = 1;

Parameter
Name Description
value Database.EncryptionConfig.GoogleDefaultEncryptionOptions
Returns
Type Description
Database.EncryptionConfig.Builder

setGoogleDefaultEncryption(Database.EncryptionConfig.GoogleDefaultEncryptionOptions.Builder builderForValue)

public Database.EncryptionConfig.Builder setGoogleDefaultEncryption(Database.EncryptionConfig.GoogleDefaultEncryptionOptions.Builder builderForValue)

Use Google default encryption.

.google.firestore.admin.v1.Database.EncryptionConfig.GoogleDefaultEncryptionOptions google_default_encryption = 1;

Parameter
Name Description
builderForValue Database.EncryptionConfig.GoogleDefaultEncryptionOptions.Builder
Returns
Type Description
Database.EncryptionConfig.Builder

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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

setUseSourceEncryption(Database.EncryptionConfig.SourceEncryptionOptions value)

public Database.EncryptionConfig.Builder setUseSourceEncryption(Database.EncryptionConfig.SourceEncryptionOptions value)

The database will use the same encryption configuration as the source.

.google.firestore.admin.v1.Database.EncryptionConfig.SourceEncryptionOptions use_source_encryption = 2;

Parameter
Name Description
value Database.EncryptionConfig.SourceEncryptionOptions
Returns
Type Description
Database.EncryptionConfig.Builder

setUseSourceEncryption(Database.EncryptionConfig.SourceEncryptionOptions.Builder builderForValue)

public Database.EncryptionConfig.Builder setUseSourceEncryption(Database.EncryptionConfig.SourceEncryptionOptions.Builder builderForValue)

The database will use the same encryption configuration as the source.

.google.firestore.admin.v1.Database.EncryptionConfig.SourceEncryptionOptions use_source_encryption = 2;

Parameter
Name Description
builderForValue Database.EncryptionConfig.SourceEncryptionOptions.Builder
Returns
Type Description
Database.EncryptionConfig.Builder