Package com.google.firestore.admin.v1

Class Database.EncryptionConfig.CustomerManagedEncryptionOptions.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderT>

com.google.protobuf.GeneratedMessageV3.Builder<Database.EncryptionConfig.CustomerManagedEncryptionOptions.Builder>

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

All Implemented Interfaces:

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

Enclosing class:

Database.EncryptionConfig.CustomerManagedEncryptionOptions

public static final class Database.EncryptionConfig.CustomerManagedEncryptionOptions.Builder
extends com.google.protobuf.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

Method Summary

Modifier and Type	Method	Description
Database.EncryptionConfig.CustomerManagedEncryptionOptions.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
Database.EncryptionConfig.CustomerManagedEncryptionOptions	build()
Database.EncryptionConfig.CustomerManagedEncryptionOptions	buildPartial()
Database.EncryptionConfig.CustomerManagedEncryptionOptions.Builder	clear()
Database.EncryptionConfig.CustomerManagedEncryptionOptions.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
Database.EncryptionConfig.CustomerManagedEncryptionOptions.Builder	clearKmsKeyName()	Required.
Database.EncryptionConfig.CustomerManagedEncryptionOptions.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
Database.EncryptionConfig.CustomerManagedEncryptionOptions.Builder	clone()
Database.EncryptionConfig.CustomerManagedEncryptionOptions	getDefaultInstanceForType()
static final com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
String	getKmsKeyName()	Required.
com.google.protobuf.ByteString	getKmsKeyNameBytes()	Required.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
final boolean	isInitialized()
Database.EncryptionConfig.CustomerManagedEncryptionOptions.Builder	mergeFrom(Database.EncryptionConfig.CustomerManagedEncryptionOptions other)
Database.EncryptionConfig.CustomerManagedEncryptionOptions.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
Database.EncryptionConfig.CustomerManagedEncryptionOptions.Builder	mergeFrom(com.google.protobuf.Message other)
final Database.EncryptionConfig.CustomerManagedEncryptionOptions.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
Database.EncryptionConfig.CustomerManagedEncryptionOptions.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
Database.EncryptionConfig.CustomerManagedEncryptionOptions.Builder	setKmsKeyName(String value)	Required.
Database.EncryptionConfig.CustomerManagedEncryptionOptions.Builder	setKmsKeyNameBytes(com.google.protobuf.ByteString value)	Required.
Database.EncryptionConfig.CustomerManagedEncryptionOptions.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
final Database.EncryptionConfig.CustomerManagedEncryptionOptions.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Methods inherited from interface com.google.protobuf.MessageLite.Builder

mergeFrom

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Method Details

getDescriptor

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

internalGetFieldAccessorTable

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

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<Database.EncryptionConfig.CustomerManagedEncryptionOptions.Builder>

clear

public Database.EncryptionConfig.CustomerManagedEncryptionOptions.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<Database.EncryptionConfig.CustomerManagedEncryptionOptions.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<Database.EncryptionConfig.CustomerManagedEncryptionOptions.Builder>

getDefaultInstanceForType

public Database.EncryptionConfig.CustomerManagedEncryptionOptions getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public Database.EncryptionConfig.CustomerManagedEncryptionOptions build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public Database.EncryptionConfig.CustomerManagedEncryptionOptions buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone

public Database.EncryptionConfig.CustomerManagedEncryptionOptions.Builder clone()

Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<Database.EncryptionConfig.CustomerManagedEncryptionOptions.Builder>

setField

public Database.EncryptionConfig.CustomerManagedEncryptionOptions.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
 Object value)

Specified by:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<Database.EncryptionConfig.CustomerManagedEncryptionOptions.Builder>

clearField

public Database.EncryptionConfig.CustomerManagedEncryptionOptions.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<Database.EncryptionConfig.CustomerManagedEncryptionOptions.Builder>

clearOneof

public Database.EncryptionConfig.CustomerManagedEncryptionOptions.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Database.EncryptionConfig.CustomerManagedEncryptionOptions.Builder>

setRepeatedField

public Database.EncryptionConfig.CustomerManagedEncryptionOptions.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
 int index,
 Object value)

Specified by:

setRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Database.EncryptionConfig.CustomerManagedEncryptionOptions.Builder>

addRepeatedField

public Database.EncryptionConfig.CustomerManagedEncryptionOptions.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
 Object value)

Specified by:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Database.EncryptionConfig.CustomerManagedEncryptionOptions.Builder>

mergeFrom

public Database.EncryptionConfig.CustomerManagedEncryptionOptions.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Database.EncryptionConfig.CustomerManagedEncryptionOptions.Builder>

mergeFrom

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

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Database.EncryptionConfig.CustomerManagedEncryptionOptions.Builder>

mergeFrom

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

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Database.EncryptionConfig.CustomerManagedEncryptionOptions.Builder>

Throws:

IOException

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.

setKmsKeyName

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

Parameters:

value - The kmsKeyName to set.

Returns:

This builder for chaining.

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:

This builder for chaining.

setKmsKeyNameBytes

public Database.EncryptionConfig.CustomerManagedEncryptionOptions.Builder setKmsKeyNameBytes(com.google.protobuf.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];

Parameters:

value - The bytes for kmsKeyName to set.

Returns:

This builder for chaining.

setUnknownFields

public final Database.EncryptionConfig.CustomerManagedEncryptionOptions.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Database.EncryptionConfig.CustomerManagedEncryptionOptions.Builder>

mergeUnknownFields

public final Database.EncryptionConfig.CustomerManagedEncryptionOptions.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Database.EncryptionConfig.CustomerManagedEncryptionOptions.Builder>