Class RestoreDatabaseEncryptionConfig.Builder (6.23.4)

public static final class RestoreDatabaseEncryptionConfig.Builder extends GeneratedMessageV3.Builder<RestoreDatabaseEncryptionConfig.Builder> implements RestoreDatabaseEncryptionConfigOrBuilder

Encryption configuration for the restored database.

Protobuf type google.spanner.admin.database.v1.RestoreDatabaseEncryptionConfig

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()
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 RestoreDatabaseEncryptionConfig.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns Overrides

build()

public RestoreDatabaseEncryptionConfig build()
Returns

buildPartial()

public RestoreDatabaseEncryptionConfig buildPartial()
Returns

clear()

public RestoreDatabaseEncryptionConfig.Builder clear()
Returns Overrides

clearEncryptionType()

public RestoreDatabaseEncryptionConfig.Builder clearEncryptionType()

Required. The encryption type of the restored database.

.google.spanner.admin.database.v1.RestoreDatabaseEncryptionConfig.EncryptionType encryption_type = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
RestoreDatabaseEncryptionConfig.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public RestoreDatabaseEncryptionConfig.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns Overrides

clearKmsKeyName()

public RestoreDatabaseEncryptionConfig.Builder clearKmsKeyName()

Optional. The Cloud KMS key that will be used to encrypt/decrypt the restored database. This field should be set only when encryption_type is CUSTOMER_MANAGED_ENCRYPTION. Values are of the form projects/<project>/locations/<location>/keyRings/<key_ring>/cryptoKeys/<kms_key_name>.

string kms_key_name = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
RestoreDatabaseEncryptionConfig.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public RestoreDatabaseEncryptionConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns Overrides

clone()

public RestoreDatabaseEncryptionConfig.Builder clone()
Returns Overrides

getDefaultInstanceForType()

public RestoreDatabaseEncryptionConfig getDefaultInstanceForType()
Returns

getDescriptorForType()

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

getEncryptionType()

public RestoreDatabaseEncryptionConfig.EncryptionType getEncryptionType()

Required. The encryption type of the restored database.

.google.spanner.admin.database.v1.RestoreDatabaseEncryptionConfig.EncryptionType encryption_type = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
RestoreDatabaseEncryptionConfig.EncryptionType

The encryptionType.

getEncryptionTypeValue()

public int getEncryptionTypeValue()

Required. The encryption type of the restored database.

.google.spanner.admin.database.v1.RestoreDatabaseEncryptionConfig.EncryptionType encryption_type = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The enum numeric value on the wire for encryptionType.

getKmsKeyName()

public String getKmsKeyName()

Optional. The Cloud KMS key that will be used to encrypt/decrypt the restored database. This field should be set only when encryption_type is CUSTOMER_MANAGED_ENCRYPTION. Values are of the form projects/<project>/locations/<location>/keyRings/<key_ring>/cryptoKeys/<kms_key_name>.

string kms_key_name = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The kmsKeyName.

getKmsKeyNameBytes()

public ByteString getKmsKeyNameBytes()

Optional. The Cloud KMS key that will be used to encrypt/decrypt the restored database. This field should be set only when encryption_type is CUSTOMER_MANAGED_ENCRYPTION. Values are of the form projects/<project>/locations/<location>/keyRings/<key_ring>/cryptoKeys/<kms_key_name>.

string kms_key_name = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

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(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

public RestoreDatabaseEncryptionConfig.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns Overrides

mergeFrom(RestoreDatabaseEncryptionConfig other)

public RestoreDatabaseEncryptionConfig.Builder mergeFrom(RestoreDatabaseEncryptionConfig other)
Parameter
Name Description
other RestoreDatabaseEncryptionConfig
Returns

mergeUnknownFields(UnknownFieldSet unknownFields)

public final RestoreDatabaseEncryptionConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns Overrides

setEncryptionType(RestoreDatabaseEncryptionConfig.EncryptionType value)

public RestoreDatabaseEncryptionConfig.Builder setEncryptionType(RestoreDatabaseEncryptionConfig.EncryptionType value)

Required. The encryption type of the restored database.

.google.spanner.admin.database.v1.RestoreDatabaseEncryptionConfig.EncryptionType encryption_type = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value RestoreDatabaseEncryptionConfig.EncryptionType

The encryptionType to set.

Returns
Type Description
RestoreDatabaseEncryptionConfig.Builder

This builder for chaining.

setEncryptionTypeValue(int value)

public RestoreDatabaseEncryptionConfig.Builder setEncryptionTypeValue(int value)

Required. The encryption type of the restored database.

.google.spanner.admin.database.v1.RestoreDatabaseEncryptionConfig.EncryptionType encryption_type = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value int

The enum numeric value on the wire for encryptionType to set.

Returns
Type Description
RestoreDatabaseEncryptionConfig.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

setKmsKeyName(String value)

public RestoreDatabaseEncryptionConfig.Builder setKmsKeyName(String value)

Optional. The Cloud KMS key that will be used to encrypt/decrypt the restored database. This field should be set only when encryption_type is CUSTOMER_MANAGED_ENCRYPTION. Values are of the form projects/<project>/locations/<location>/keyRings/<key_ring>/cryptoKeys/<kms_key_name>.

string kms_key_name = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The kmsKeyName to set.

Returns
Type Description
RestoreDatabaseEncryptionConfig.Builder

This builder for chaining.

setKmsKeyNameBytes(ByteString value)

public RestoreDatabaseEncryptionConfig.Builder setKmsKeyNameBytes(ByteString value)

Optional. The Cloud KMS key that will be used to encrypt/decrypt the restored database. This field should be set only when encryption_type is CUSTOMER_MANAGED_ENCRYPTION. Values are of the form projects/<project>/locations/<location>/keyRings/<key_ring>/cryptoKeys/<kms_key_name>.

string kms_key_name = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes for kmsKeyName to set.

Returns
Type Description
RestoreDatabaseEncryptionConfig.Builder

This builder for chaining.

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

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

setUnknownFields(UnknownFieldSet unknownFields)

public final RestoreDatabaseEncryptionConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns Overrides