Package com.google.firestore.admin.v1

Interface Database.EncryptionConfig.CustomerManagedEncryptionOptionsOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Database.EncryptionConfig.CustomerManagedEncryptionOptions, Database.EncryptionConfig.CustomerManagedEncryptionOptions.Builder
Enclosing class:
Database.EncryptionConfig
public static interface Database.EncryptionConfig.CustomerManagedEncryptionOptionsOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getKmsKeyName()
    Required.
    com.google.protobuf.ByteString
    getKmsKeyNameBytes()
    Required.

    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()
       Required. Only keys in the same location as the database are allowed to
 be used for encryption.

 For Firestore's nam5 multi-region, this corresponds to Cloud KMS
 multi-region us. For Firestore's eur3 multi-region, this corresponds to
 Cloud KMS multi-region europe. See
 https://cloud.google.com/kms/docs/locations.

 The expected format is
 `projects/{project_id}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`.
      string kms_key_name = 1 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The kmsKeyName.

    • getKmsKeyNameBytes

      com.google.protobuf.ByteString getKmsKeyNameBytes()
       Required. Only keys in the same location as the database are allowed to
 be used for encryption.

 For Firestore's nam5 multi-region, this corresponds to Cloud KMS
 multi-region us. For Firestore's eur3 multi-region, this corresponds to
 Cloud KMS multi-region europe. See
 https://cloud.google.com/kms/docs/locations.

 The expected format is
 `projects/{project_id}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`.
      string kms_key_name = 1 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The bytes for kmsKeyName.