Class: Google::Apis::DlpV2::GooglePrivacyDlpV2CharacterMaskConfig

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

Overview

Partially mask a string by replacing a given number of characters with a fixed character. Masking can start from the beginning or end of the string. This can be used on data of any type (numbers, longs, and so on) and when de- identifying structured data we'll attempt to preserve the original data's type. (This allows you to take a long like 123 and modify it to a string like **3.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GooglePrivacyDlpV2CharacterMaskConfig

Returns a new instance of GooglePrivacyDlpV2CharacterMaskConfig.



1052
1053
1054
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 1052

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

Instance Attribute Details

#characters_to_ignore ⇒ Array<Google::Apis::DlpV2::GooglePrivacyDlpV2CharsToIgnore>

When masking a string, items in this list will be skipped when replacing characters. For example, if the input string is 555-555-5555 and you instruct Cloud DLP to skip - and mask 5 characters with *, Cloud DLP returns ***-**5-5555. Corresponds to the JSON property charactersToIgnore

Returns:



1019
1020
1021
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 1019

def characters_to_ignore
  @characters_to_ignore
end

#masking_character ⇒ String

Character to use to mask the sensitive values—for example, * for an alphabetic string such as a name, or 0 for a numeric string such as ZIP code or credit card number. This string must have a length of 1. If not supplied, this value defaults to * for strings, and 0 for digits. Corresponds to the JSON property maskingCharacter

Returns:

  • (String) 


1027
1028
1029
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 1027

def masking_character
  @masking_character
end

#number_to_mask ⇒ Fixnum

Number of characters to mask. If not set, all matching chars will be masked. Skipped characters do not count towards this tally. If number_to_mask is negative, this denotes inverse masking. Cloud DLP masks all but a number of characters. For example, suppose you have the following values: - masking_character is * - number_to_mask is -4 - reverse_order is false - CharsToIgnore includes - - Input string is 1234-5678-9012-3456 The resulting de-identified string is ****-****-****-3456. Cloud DLP masks all but the last four characters. If reverse_order is true, all but the first four characters are masked as 1234-****-****-****. Corresponds to the JSON property numberToMask

Returns:

  • (Fixnum) 


1040
1041
1042
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 1040

def number_to_mask
  @number_to_mask
end

#reverse_order ⇒ Boolean Also known as: reverse_order?

Mask characters in reverse order. For example, if masking_character is 0, number_to_mask is 14, and reverse_order is false, then the input string 1234-5678-9012-3456 is masked as 00000000000000-3456. If masking_character is *, number_to_mask is 3, and reverse_order is true, then the string 12345 is masked as 12***. Corresponds to the JSON property reverseOrder

Returns:

  • (Boolean) 


1049
1050
1051
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 1049

def reverse_order
  @reverse_order
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1057
1058
1059
1060
1061
1062
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 1057

def update!(**args)
  @characters_to_ignore = args[:characters_to_ignore] if args.key?(:characters_to_ignore)
  @masking_character = args[:masking_character] if args.key?(:masking_character)
  @number_to_mask = args[:number_to_mask] if args.key?(:number_to_mask)
  @reverse_order = args[:reverse_order] if args.key?(:reverse_order)
end