Cloud Data Loss Prevention (DLP) V2 API - Class Google::Cloud::Dlp::V2::CryptoKey (v1.15.0)

Reference documentation and code samples for the Cloud Data Loss Prevention (DLP) V2 API class Google::Cloud::Dlp::V2::CryptoKey.

This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#kms_wrapped

def kms_wrapped() -> ::Google::Cloud::Dlp::V2::KmsWrappedCryptoKey
Returns
  • (::Google::Cloud::Dlp::V2::KmsWrappedCryptoKey) — Key wrapped using Cloud KMS

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

#kms_wrapped=

def kms_wrapped=(value) -> ::Google::Cloud::Dlp::V2::KmsWrappedCryptoKey
Parameter
  • value (::Google::Cloud::Dlp::V2::KmsWrappedCryptoKey) — Key wrapped using Cloud KMS

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

Returns
  • (::Google::Cloud::Dlp::V2::KmsWrappedCryptoKey) — Key wrapped using Cloud KMS

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

#transient

def transient() -> ::Google::Cloud::Dlp::V2::TransientCryptoKey
Returns
  • (::Google::Cloud::Dlp::V2::TransientCryptoKey) — Transient crypto key

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

#transient=

def transient=(value) -> ::Google::Cloud::Dlp::V2::TransientCryptoKey
Parameter
  • value (::Google::Cloud::Dlp::V2::TransientCryptoKey) — Transient crypto key

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

Returns
  • (::Google::Cloud::Dlp::V2::TransientCryptoKey) — Transient crypto key

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

#unwrapped

def unwrapped() -> ::Google::Cloud::Dlp::V2::UnwrappedCryptoKey
Returns
  • (::Google::Cloud::Dlp::V2::UnwrappedCryptoKey) — Unwrapped crypto key

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

#unwrapped=

def unwrapped=(value) -> ::Google::Cloud::Dlp::V2::UnwrappedCryptoKey
Parameter
  • value (::Google::Cloud::Dlp::V2::UnwrappedCryptoKey) — Unwrapped crypto key

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

Returns
  • (::Google::Cloud::Dlp::V2::UnwrappedCryptoKey) — Unwrapped crypto key

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