Class RestoreDatabaseEncryptionConfig.Builder (6.83.0) 

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

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > RestoreDatabaseEncryptionConfig.Builder

Static Methods

getDescriptor()

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

Methods

addAllKmsKeyNames(Iterable<String> values)

public RestoreDatabaseEncryptionConfig.Builder addAllKmsKeyNames(Iterable<String> values)

Optional. Specifies the KMS configuration for the one or more keys used to encrypt the database. Values are of the form projects/<project>/locations/<location>/keyRings/<key_ring>/cryptoKeys/<kms_key_name>.

The keys referenced by kms_key_names must fully cover all regions of the database instance configuration. Some examples:

  • For single region database instance configs, specify a single regional location KMS key.
  • For multi-regional database instance configs of type GOOGLE_MANAGED, either specify a multi-regional location KMS key or multiple regional location KMS keys that cover all regions in the instance config.
  • For a database instance config of type USER_MANAGED, please specify only regional location KMS keys to cover each region in the instance config. Multi-regional location KMS keys are not supported for USER_MANAGED instance configs.

repeated string kms_key_names = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
values Iterable<String>

The kmsKeyNames to add.
Returns
Type Description
RestoreDatabaseEncryptionConfig.Builder

This builder for chaining.

addKmsKeyNames(String value)

public RestoreDatabaseEncryptionConfig.Builder addKmsKeyNames(String value)

Optional. Specifies the KMS configuration for the one or more keys used to encrypt the database. Values are of the form projects/<project>/locations/<location>/keyRings/<key_ring>/cryptoKeys/<kms_key_name>.

The keys referenced by kms_key_names must fully cover all regions of the database instance configuration. Some examples:

  • For single region database instance configs, specify a single regional location KMS key.
  • For multi-regional database instance configs of type GOOGLE_MANAGED, either specify a multi-regional location KMS key or multiple regional location KMS keys that cover all regions in the instance config.
  • For a database instance config of type USER_MANAGED, please specify only regional location KMS keys to cover each region in the instance config. Multi-regional location KMS keys are not supported for USER_MANAGED instance configs.

repeated string kms_key_names = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The kmsKeyNames to add.
Returns
Type Description
RestoreDatabaseEncryptionConfig.Builder

This builder for chaining.

addKmsKeyNamesBytes(ByteString value)

public RestoreDatabaseEncryptionConfig.Builder addKmsKeyNamesBytes(ByteString value)

Optional. Specifies the KMS configuration for the one or more keys used to encrypt the database. Values are of the form projects/<project>/locations/<location>/keyRings/<key_ring>/cryptoKeys/<kms_key_name>.

The keys referenced by kms_key_names must fully cover all regions of the database instance configuration. Some examples:

  • For single region database instance configs, specify a single regional location KMS key.
  • For multi-regional database instance configs of type GOOGLE_MANAGED, either specify a multi-regional location KMS key or multiple regional location KMS keys that cover all regions in the instance config.
  • For a database instance config of type USER_MANAGED, please specify only regional location KMS keys to cover each region in the instance config. Multi-regional location KMS keys are not supported for USER_MANAGED instance configs.

repeated string kms_key_names = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes of the kmsKeyNames to add.
Returns
Type Description
RestoreDatabaseEncryptionConfig.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public RestoreDatabaseEncryptionConfig build()
Returns
Type Description
RestoreDatabaseEncryptionConfig

buildPartial()

public RestoreDatabaseEncryptionConfig buildPartial()
Returns
Type Description
RestoreDatabaseEncryptionConfig

clear()

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

This builder for chaining.

clearKmsKeyNames()

public RestoreDatabaseEncryptionConfig.Builder clearKmsKeyNames()

Optional. Specifies the KMS configuration for the one or more keys used to encrypt the database. Values are of the form projects/<project>/locations/<location>/keyRings/<key_ring>/cryptoKeys/<kms_key_name>.

The keys referenced by kms_key_names must fully cover all regions of the database instance configuration. Some examples:

  • For single region database instance configs, specify a single regional location KMS key.
  • For multi-regional database instance configs of type GOOGLE_MANAGED, either specify a multi-regional location KMS key or multiple regional location KMS keys that cover all regions in the instance config.
  • For a database instance config of type USER_MANAGED, please specify only regional location KMS keys to cover each region in the instance config. Multi-regional location KMS keys are not supported for USER_MANAGED instance configs.

repeated string kms_key_names = 3 [(.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
Type Description
RestoreDatabaseEncryptionConfig.Builder
Overrides

clone()

public RestoreDatabaseEncryptionConfig.Builder clone()
Returns
Type Description
RestoreDatabaseEncryptionConfig.Builder
Overrides

getDefaultInstanceForType()

public RestoreDatabaseEncryptionConfig getDefaultInstanceForType()
Returns
Type Description
RestoreDatabaseEncryptionConfig

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.

getKmsKeyNames(int index)

public String getKmsKeyNames(int index)

Optional. Specifies the KMS configuration for the one or more keys used to encrypt the database. Values are of the form projects/<project>/locations/<location>/keyRings/<key_ring>/cryptoKeys/<kms_key_name>.

The keys referenced by kms_key_names must fully cover all regions of the database instance configuration. Some examples:

  • For single region database instance configs, specify a single regional location KMS key.
  • For multi-regional database instance configs of type GOOGLE_MANAGED, either specify a multi-regional location KMS key or multiple regional location KMS keys that cover all regions in the instance config.
  • For a database instance config of type USER_MANAGED, please specify only regional location KMS keys to cover each region in the instance config. Multi-regional location KMS keys are not supported for USER_MANAGED instance configs.

repeated string kms_key_names = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The kmsKeyNames at the given index.

getKmsKeyNamesBytes(int index)

public ByteString getKmsKeyNamesBytes(int index)

Optional. Specifies the KMS configuration for the one or more keys used to encrypt the database. Values are of the form projects/<project>/locations/<location>/keyRings/<key_ring>/cryptoKeys/<kms_key_name>.

The keys referenced by kms_key_names must fully cover all regions of the database instance configuration. Some examples:

  • For single region database instance configs, specify a single regional location KMS key.
  • For multi-regional database instance configs of type GOOGLE_MANAGED, either specify a multi-regional location KMS key or multiple regional location KMS keys that cover all regions in the instance config.
  • For a database instance config of type USER_MANAGED, please specify only regional location KMS keys to cover each region in the instance config. Multi-regional location KMS keys are not supported for USER_MANAGED instance configs.

repeated string kms_key_names = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the kmsKeyNames at the given index.

getKmsKeyNamesCount()

public int getKmsKeyNamesCount()

Optional. Specifies the KMS configuration for the one or more keys used to encrypt the database. Values are of the form projects/<project>/locations/<location>/keyRings/<key_ring>/cryptoKeys/<kms_key_name>.

The keys referenced by kms_key_names must fully cover all regions of the database instance configuration. Some examples:

  • For single region database instance configs, specify a single regional location KMS key.
  • For multi-regional database instance configs of type GOOGLE_MANAGED, either specify a multi-regional location KMS key or multiple regional location KMS keys that cover all regions in the instance config.
  • For a database instance config of type USER_MANAGED, please specify only regional location KMS keys to cover each region in the instance config. Multi-regional location KMS keys are not supported for USER_MANAGED instance configs.

repeated string kms_key_names = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
int

The count of kmsKeyNames.

getKmsKeyNamesList()

public ProtocolStringList getKmsKeyNamesList()

Optional. Specifies the KMS configuration for the one or more keys used to encrypt the database. Values are of the form projects/<project>/locations/<location>/keyRings/<key_ring>/cryptoKeys/<kms_key_name>.

The keys referenced by kms_key_names must fully cover all regions of the database instance configuration. Some examples:

  • For single region database instance configs, specify a single regional location KMS key.
  • For multi-regional database instance configs of type GOOGLE_MANAGED, either specify a multi-regional location KMS key or multiple regional location KMS keys that cover all regions in the instance config.
  • For a database instance config of type USER_MANAGED, please specify only regional location KMS keys to cover each region in the instance config. Multi-regional location KMS keys are not supported for USER_MANAGED instance configs.

repeated string kms_key_names = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
ProtocolStringList

A list containing the kmsKeyNames.

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
Type Description
RestoreDatabaseEncryptionConfig.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

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

mergeFrom(RestoreDatabaseEncryptionConfig other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

public final RestoreDatabaseEncryptionConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
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
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
Type Description
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
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.

setKmsKeyNames(int index, String value)

public RestoreDatabaseEncryptionConfig.Builder setKmsKeyNames(int index, String value)

Optional. Specifies the KMS configuration for the one or more keys used to encrypt the database. Values are of the form projects/<project>/locations/<location>/keyRings/<key_ring>/cryptoKeys/<kms_key_name>.

The keys referenced by kms_key_names must fully cover all regions of the database instance configuration. Some examples:

  • For single region database instance configs, specify a single regional location KMS key.
  • For multi-regional database instance configs of type GOOGLE_MANAGED, either specify a multi-regional location KMS key or multiple regional location KMS keys that cover all regions in the instance config.
  • For a database instance config of type USER_MANAGED, please specify only regional location KMS keys to cover each region in the instance config. Multi-regional location KMS keys are not supported for USER_MANAGED instance configs.

repeated string kms_key_names = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameters
Name Description
index int

The index to set the value at.
value String

The kmsKeyNames 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
Type Description
RestoreDatabaseEncryptionConfig.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

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