Class: Google::Cloud::Firestore::Admin::V1::Database::EncryptionConfig

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/firestore/admin/v1/database.rb

Overview

Encryption configuration for a new database being created from another source.

The source could be a Backup .

Defined Under Namespace

Classes: CustomerManagedEncryptionOptions, GoogleDefaultEncryptionOptions, SourceEncryptionOptions

Instance Attribute Summary collapse

Instance Attribute Details

#customer_managed_encryption ⇒ ::Google::Cloud::Firestore::Admin::V1::Database::EncryptionConfig::CustomerManagedEncryptionOptions

Returns Use Customer Managed Encryption Keys (CMEK) for encryption.

Note: The following fields are mutually exclusive: customer_managed_encryption, google_default_encryption, use_source_encryption. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'proto_docs/google/firestore/admin/v1/database.rb', line 191

class EncryptionConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The configuration options for using Google default encryption.
  class GoogleDefaultEncryptionOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The configuration options for using the same encryption method as the
  # source.
  class SourceEncryptionOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The configuration options for using CMEK (Customer Managed Encryption
  # Key) encryption.
  # @!attribute [rw] kms_key_name
  #   @return [::String]
  #     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}`.
  class CustomerManagedEncryptionOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#google_default_encryption ⇒ ::Google::Cloud::Firestore::Admin::V1::Database::EncryptionConfig::GoogleDefaultEncryptionOptions

Returns Use Google default encryption.

Note: The following fields are mutually exclusive: google_default_encryption, use_source_encryption, customer_managed_encryption. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'proto_docs/google/firestore/admin/v1/database.rb', line 191

class EncryptionConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The configuration options for using Google default encryption.
  class GoogleDefaultEncryptionOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The configuration options for using the same encryption method as the
  # source.
  class SourceEncryptionOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The configuration options for using CMEK (Customer Managed Encryption
  # Key) encryption.
  # @!attribute [rw] kms_key_name
  #   @return [::String]
  #     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}`.
  class CustomerManagedEncryptionOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#use_source_encryption ⇒ ::Google::Cloud::Firestore::Admin::V1::Database::EncryptionConfig::SourceEncryptionOptions

Returns The database will use the same encryption configuration as the source.

Note: The following fields are mutually exclusive: use_source_encryption, google_default_encryption, customer_managed_encryption. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'proto_docs/google/firestore/admin/v1/database.rb', line 191

class EncryptionConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The configuration options for using Google default encryption.
  class GoogleDefaultEncryptionOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The configuration options for using the same encryption method as the
  # source.
  class SourceEncryptionOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The configuration options for using CMEK (Customer Managed Encryption
  # Key) encryption.
  # @!attribute [rw] kms_key_name
  #   @return [::String]
  #     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}`.
  class CustomerManagedEncryptionOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end