Class RestoreDatabaseEncryptionConfig.Builder (6.25.1)

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

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public RestoreDatabaseEncryptionConfig.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
RestoreDatabaseEncryptionConfig.Builder
Overrides

build()

public RestoreDatabaseEncryptionConfig build()
Returns
TypeDescription
RestoreDatabaseEncryptionConfig

buildPartial()

public RestoreDatabaseEncryptionConfig buildPartial()
Returns
TypeDescription
RestoreDatabaseEncryptionConfig

clear()

public RestoreDatabaseEncryptionConfig.Builder clear()
Returns
TypeDescription
RestoreDatabaseEncryptionConfig.Builder
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
TypeDescription
RestoreDatabaseEncryptionConfig.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public RestoreDatabaseEncryptionConfig.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
RestoreDatabaseEncryptionConfig.Builder
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
TypeDescription
RestoreDatabaseEncryptionConfig.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public RestoreDatabaseEncryptionConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
RestoreDatabaseEncryptionConfig.Builder
Overrides

clone()

public RestoreDatabaseEncryptionConfig.Builder clone()
Returns
TypeDescription
RestoreDatabaseEncryptionConfig.Builder
Overrides

getDefaultInstanceForType()

public RestoreDatabaseEncryptionConfig getDefaultInstanceForType()
Returns
TypeDescription
RestoreDatabaseEncryptionConfig

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for kmsKeyName.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public RestoreDatabaseEncryptionConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RestoreDatabaseEncryptionConfig.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public RestoreDatabaseEncryptionConfig.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
RestoreDatabaseEncryptionConfig.Builder
Overrides

mergeFrom(RestoreDatabaseEncryptionConfig other)

public RestoreDatabaseEncryptionConfig.Builder mergeFrom(RestoreDatabaseEncryptionConfig other)
Parameter
NameDescription
otherRestoreDatabaseEncryptionConfig
Returns
TypeDescription
RestoreDatabaseEncryptionConfig.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final RestoreDatabaseEncryptionConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
RestoreDatabaseEncryptionConfig.Builder
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
NameDescription
valueRestoreDatabaseEncryptionConfig.EncryptionType

The encryptionType to set.

Returns
TypeDescription
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
NameDescription
valueint

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

Returns
TypeDescription
RestoreDatabaseEncryptionConfig.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public RestoreDatabaseEncryptionConfig.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
RestoreDatabaseEncryptionConfig.Builder
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
NameDescription
valueString

The kmsKeyName to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for kmsKeyName to set.

Returns
TypeDescription
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
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
RestoreDatabaseEncryptionConfig.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final RestoreDatabaseEncryptionConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
RestoreDatabaseEncryptionConfig.Builder
Overrides