Backup and DR Service V1 API - Class Google::Cloud::BackupDR::V1::CustomerEncryptionKey (v0.5.0)

Reference documentation and code samples for the Backup and DR Service V1 API class Google::Cloud::BackupDR::V1::CustomerEncryptionKey.

A customer-supplied encryption key.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#kms_key_name

def kms_key_name() -> ::String
Returns
  • (::String) — Optional. The name of the encryption key that is stored in Google Cloud KMS.

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

#kms_key_name=

def kms_key_name=(value) -> ::String
Parameter
  • value (::String) — Optional. The name of the encryption key that is stored in Google Cloud KMS.

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

Returns
  • (::String) — Optional. The name of the encryption key that is stored in Google Cloud KMS.

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

#kms_key_service_account

def kms_key_service_account() -> ::String
Returns
  • (::String) — Optional. The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.

#kms_key_service_account=

def kms_key_service_account=(value) -> ::String
Parameter
  • value (::String) — Optional. The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.
Returns
  • (::String) — Optional. The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.

#raw_key

def raw_key() -> ::String
Returns
  • (::String) — Optional. Specifies a 256-bit customer-supplied encryption key.

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

#raw_key=

def raw_key=(value) -> ::String
Parameter
  • value (::String) — Optional. Specifies a 256-bit customer-supplied encryption key.

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

Returns
  • (::String) — Optional. Specifies a 256-bit customer-supplied encryption key.

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

#rsa_encrypted_key

def rsa_encrypted_key() -> ::String
Returns
  • (::String) — Optional. RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

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

#rsa_encrypted_key=

def rsa_encrypted_key=(value) -> ::String
Parameter
  • value (::String) — Optional. RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

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

Returns
  • (::String) — Optional. RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

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