Class: Google::Apis::DlpV2::GooglePrivacyDlpV2CryptoReplaceFfxFpeConfig

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/dlp_v2/classes.rb,
generated/google/apis/dlp_v2/representations.rb,
generated/google/apis/dlp_v2/representations.rb

Overview

Replaces an identifier with a surrogate using FPE with the FFX mode of operation; however when used in the ReidentifyContent API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See Pseudonymization for example usage.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ GooglePrivacyDlpV2CryptoReplaceFfxFpeConfig

Returns a new instance of GooglePrivacyDlpV2CryptoReplaceFfxFpeConfig



1024
1025
1026
 
# File 'generated/google/apis/dlp_v2/classes.rb', line 1024

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#common_alphabet ⇒ String

Corresponds to the JSON property commonAlphabet

Returns:

  • (String) 


987
988
989
 
# File 'generated/google/apis/dlp_v2/classes.rb', line 987

def common_alphabet
  @common_alphabet
end

#context ⇒ Google::Apis::DlpV2::GooglePrivacyDlpV2FieldId

General identifier of a data field in a storage service. Corresponds to the JSON property context

Returns:



992
993
994
 
# File 'generated/google/apis/dlp_v2/classes.rb', line 992

def context
  @context
end

#crypto_key ⇒ Google::Apis::DlpV2::GooglePrivacyDlpV2CryptoKey

This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by KMS). When using KMS to wrap/unwrap DEKs, be sure to set an appropriate IAM policy on the KMS CryptoKey (KEK) to ensure an attacker cannot unwrap the data crypto key. Corresponds to the JSON property cryptoKey

Returns:



1001
1002
1003
 
# File 'generated/google/apis/dlp_v2/classes.rb', line 1001

def crypto_key
  @crypto_key
end

#custom_alphabet ⇒ String

This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 62]. This must be encoded as ASCII. The order of characters does not matter. Corresponds to the JSON property customAlphabet

Returns:

  • (String) 


1012
1013
1014
 
# File 'generated/google/apis/dlp_v2/classes.rb', line 1012

def custom_alphabet
  @custom_alphabet
end

#radix ⇒ Fixnum

The native way to select the alphabet. Must be in the range [2, 62]. Corresponds to the JSON property radix

Returns:

  • (Fixnum) 


1017
1018
1019
 
# File 'generated/google/apis/dlp_v2/classes.rb', line 1017

def radix
  @radix
end

#surrogate_info_type ⇒ Google::Apis::DlpV2::GooglePrivacyDlpV2InfoType

Type of information detected by the API. Corresponds to the JSON property surrogateInfoType

Returns:



1022
1023
1024
 
# File 'generated/google/apis/dlp_v2/classes.rb', line 1022

def surrogate_info_type
  @surrogate_info_type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1029
1030
1031
1032
1033
1034
1035
1036
 
# File 'generated/google/apis/dlp_v2/classes.rb', line 1029

def update!(**args)
  @common_alphabet = args[:common_alphabet] if args.key?(:common_alphabet)
  @context = args[:context] if args.key?(:context)
  @crypto_key = args[:crypto_key] if args.key?(:crypto_key)
  @custom_alphabet = args[:custom_alphabet] if args.key?(:custom_alphabet)
  @radix = args[:radix] if args.key?(:radix)
  @surrogate_info_type = args[:surrogate_info_type] if args.key?(:surrogate_info_type)
end