Class Database.EncryptionConfig (3.28.0) 

public static final class Database.EncryptionConfig extends GeneratedMessageV3 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

Inheritance

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

Static Fields

CUSTOMER_MANAGED_ENCRYPTION_FIELD_NUMBER

public static final int CUSTOMER_MANAGED_ENCRYPTION_FIELD_NUMBER
Field Value
Type Description
int

GOOGLE_DEFAULT_ENCRYPTION_FIELD_NUMBER

public static final int GOOGLE_DEFAULT_ENCRYPTION_FIELD_NUMBER
Field Value
Type Description
int

USE_SOURCE_ENCRYPTION_FIELD_NUMBER

public static final int USE_SOURCE_ENCRYPTION_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Database.EncryptionConfig getDefaultInstance()
Returns
Type Description
Database.EncryptionConfig

getDescriptor()

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

newBuilder()

public static Database.EncryptionConfig.Builder newBuilder()
Returns
Type Description
Database.EncryptionConfig.Builder

newBuilder(Database.EncryptionConfig prototype)

public static Database.EncryptionConfig.Builder newBuilder(Database.EncryptionConfig prototype)
Parameter
Name Description
prototype Database.EncryptionConfig
Returns
Type Description
Database.EncryptionConfig.Builder

parseDelimitedFrom(InputStream input)

public static Database.EncryptionConfig parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Database.EncryptionConfig
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Database.EncryptionConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Database.EncryptionConfig
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Database.EncryptionConfig parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Database.EncryptionConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Database.EncryptionConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Database.EncryptionConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Database.EncryptionConfig parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Database.EncryptionConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Database.EncryptionConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Database.EncryptionConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Database.EncryptionConfig parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Database.EncryptionConfig
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Database.EncryptionConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Database.EncryptionConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Database.EncryptionConfig parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Database.EncryptionConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Database.EncryptionConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Database.EncryptionConfig
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Database.EncryptionConfig parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Database.EncryptionConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Database.EncryptionConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Database.EncryptionConfig
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Database.EncryptionConfig> parser()
Returns
Type Description
Parser<EncryptionConfig>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
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.

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

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.

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

getParserForType()

public Parser<Database.EncryptionConfig> getParserForType()
Returns
Type Description
Parser<EncryptionConfig>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Database.EncryptionConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Database.EncryptionConfig.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException