Package com.google.spanner.admin.database.v1

Interface CreateBackupEncryptionConfigOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
CreateBackupEncryptionConfig, CreateBackupEncryptionConfig.Builder
public interface CreateBackupEncryptionConfigOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getEncryptionTypeValue

      int getEncryptionTypeValue()
       Required. The encryption type of the backup.
      .google.spanner.admin.database.v1.CreateBackupEncryptionConfig.EncryptionType encryption_type = 1 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The enum numeric value on the wire for encryptionType.

    • getEncryptionType

      CreateBackupEncryptionConfig.EncryptionType getEncryptionType()
       Required. The encryption type of the backup.
      .google.spanner.admin.database.v1.CreateBackupEncryptionConfig.EncryptionType encryption_type = 1 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The encryptionType.

    • getKmsKeyName

      String getKmsKeyName()
       Optional. The Cloud KMS key that will be used to protect the backup.
 This field should be set only when
 [encryption_type][google.spanner.admin.database.v1.CreateBackupEncryptionConfig.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:
      The kmsKeyName.

    • getKmsKeyNameBytes

      com.google.protobuf.ByteString getKmsKeyNameBytes()
       Optional. The Cloud KMS key that will be used to protect the backup.
 This field should be set only when
 [encryption_type][google.spanner.admin.database.v1.CreateBackupEncryptionConfig.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:
      The bytes for kmsKeyName.

    • getKmsKeyNamesList

      List<String> getKmsKeyNamesList()
       Optional. Specifies the KMS configuration for the one or more keys used to
 protect the backup. 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 backup's instance configuration. Some examples:
 * For single region instance configs, specify a single regional
 location KMS key.
 * For multi-regional 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 an 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:
      A list containing the kmsKeyNames.

    • getKmsKeyNamesCount

      int getKmsKeyNamesCount()
       Optional. Specifies the KMS configuration for the one or more keys used to
 protect the backup. 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 backup's instance configuration. Some examples:
 * For single region instance configs, specify a single regional
 location KMS key.
 * For multi-regional 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 an 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:
      The count of kmsKeyNames.

    • getKmsKeyNames

      String getKmsKeyNames(int index)
       Optional. Specifies the KMS configuration for the one or more keys used to
 protect the backup. 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 backup's instance configuration. Some examples:
 * For single region instance configs, specify a single regional
 location KMS key.
 * For multi-regional 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 an 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:
      index - The index of the element to return.
      Returns:
      The kmsKeyNames at the given index.

    • getKmsKeyNamesBytes

      com.google.protobuf.ByteString getKmsKeyNamesBytes(int index)
       Optional. Specifies the KMS configuration for the one or more keys used to
 protect the backup. 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 backup's instance configuration. Some examples:
 * For single region instance configs, specify a single regional
 location KMS key.
 * For multi-regional 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 an 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:
      index - The index of the value to return.
      Returns:
      The bytes of the kmsKeyNames at the given index.