Package com.google.firestore.admin.v1

Interface Database.CmekConfigOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getActiveKeyVersion(int index)
    Output only.
    com.google.protobuf.ByteString
    getActiveKeyVersionBytes(int index)
    Output only.
    int
    getActiveKeyVersionCount()
    Output only.
    List<String>
    getActiveKeyVersionList()
    Output only.
    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 this 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 this 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.

    • getActiveKeyVersionList

      List<String> getActiveKeyVersionList()
       Output only. Currently in-use [KMS key
 versions](https://cloud.google.com/kms/docs/resource-hierarchy#key_versions).
 During [key rotation](https://cloud.google.com/kms/docs/key-rotation),
 there can be multiple in-use key versions.

 The expected format is
 `projects/{project_id}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{key_version}`.
      repeated string active_key_version = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      A list containing the activeKeyVersion.

    • getActiveKeyVersionCount

      int getActiveKeyVersionCount()
       Output only. Currently in-use [KMS key
 versions](https://cloud.google.com/kms/docs/resource-hierarchy#key_versions).
 During [key rotation](https://cloud.google.com/kms/docs/key-rotation),
 there can be multiple in-use key versions.

 The expected format is
 `projects/{project_id}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{key_version}`.
      repeated string active_key_version = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The count of activeKeyVersion.

    • getActiveKeyVersion

      String getActiveKeyVersion(int index)
       Output only. Currently in-use [KMS key
 versions](https://cloud.google.com/kms/docs/resource-hierarchy#key_versions).
 During [key rotation](https://cloud.google.com/kms/docs/key-rotation),
 there can be multiple in-use key versions.

 The expected format is
 `projects/{project_id}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{key_version}`.
      repeated string active_key_version = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      index - The index of the element to return.
      Returns:
      The activeKeyVersion at the given index.

    • getActiveKeyVersionBytes

      com.google.protobuf.ByteString getActiveKeyVersionBytes(int index)
       Output only. Currently in-use [KMS key
 versions](https://cloud.google.com/kms/docs/resource-hierarchy#key_versions).
 During [key rotation](https://cloud.google.com/kms/docs/key-rotation),
 there can be multiple in-use key versions.

 The expected format is
 `projects/{project_id}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{key_version}`.
      repeated string active_key_version = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the activeKeyVersion at the given index.