GoogleApi.Firestore.V1.Model.GoogleFirestoreAdminV1CustomerManagedEncryptionOptions (google_api_firestore v0.33.0)

View Source

The configuration options for using CMEK (Customer Managed Encryption Key) encryption.

Attributes

  • kmsKeyName (type: String.t, default: nil) - 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}.

Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::
  %GoogleApi.Firestore.V1.Model.GoogleFirestoreAdminV1CustomerManagedEncryptionOptions{
    kmsKeyName: String.t() | nil
  }

Functions

decode(value, options)

@spec decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.