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

Interface EncryptionConfigOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getKmsKeyName()
    The Cloud KMS key to be used for encrypting and decrypting the database.
    com.google.protobuf.ByteString
    getKmsKeyNameBytes()
    The Cloud KMS key to be used for encrypting and decrypting the database.
    String
    getKmsKeyNames(int index)
    Specifies the KMS configuration for the one or more keys used to encrypt the database.
    com.google.protobuf.ByteString
    getKmsKeyNamesBytes(int index)
    Specifies the KMS configuration for the one or more keys used to encrypt the database.
    int
    getKmsKeyNamesCount()
    Specifies the KMS configuration for the one or more keys used to encrypt the database.
    List<String>
    getKmsKeyNamesList()
    Specifies the KMS configuration for the one or more keys used to encrypt the database.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Method Details

    • getKmsKeyName

      String getKmsKeyName()
       The Cloud KMS key to be used for encrypting and decrypting
 the database. Values are of the form
 `projects/<project>/locations/<location>/keyRings/<key_ring>/cryptoKeys/<kms_key_name>`.
      string kms_key_name = 2 [(.google.api.resource_reference) = { ... }
      Returns:
      The kmsKeyName.

    • getKmsKeyNameBytes

      com.google.protobuf.ByteString getKmsKeyNameBytes()
       The Cloud KMS key to be used for encrypting and decrypting
 the database. Values are of the form
 `projects/<project>/locations/<location>/keyRings/<key_ring>/cryptoKeys/<kms_key_name>`.
      string kms_key_name = 2 [(.google.api.resource_reference) = { ... }
      Returns:
      The bytes for kmsKeyName.

    • getKmsKeyNamesList

      List<String> getKmsKeyNamesList()
       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.resource_reference) = { ... }
      Returns:
      A list containing the kmsKeyNames.

    • getKmsKeyNamesCount

      int getKmsKeyNamesCount()
       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.resource_reference) = { ... }
      Returns:
      The count of kmsKeyNames.

    • getKmsKeyNames

      String getKmsKeyNames(int index)
       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.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)
       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.resource_reference) = { ... }
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the kmsKeyNames at the given index.