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

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

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

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ GooglePrivacyDlpV2CharacterMaskConfig

Returns a new instance of GooglePrivacyDlpV2CharacterMaskConfig



539
540
541
 
# File 'generated/google/apis/dlp_v2/classes.rb', line 539

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. For example, if your string is 555-555-5555 and you ask us to skip - and mask 5 chars with * we would produce ***-*55-5555. Corresponds to the JSON property charactersToIgnore

Returns:



513
514
515
 
# File 'generated/google/apis/dlp_v2/classes.rb', line 513

def characters_to_ignore
  @characters_to_ignore
end

#masking_character ⇒ String

Character to mask the sensitive values—for example, "" for an alphabetic string such as name, or "0" for a numeric string such as ZIP code or credit card number. String must have length 1. If not supplied, we will default to "" for strings, 0 for digits. Corresponds to the JSON property maskingCharacter

Returns:

  • (String) 


521
522
523
 
# File 'generated/google/apis/dlp_v2/classes.rb', line 521

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. Corresponds to the JSON property numberToMask

Returns:

  • (Fixnum) 


527
528
529
 
# File 'generated/google/apis/dlp_v2/classes.rb', line 527

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 1234-5678-9012-3456 -> 00000000000000-3456 If masking_character is '', number_to_mask is 3, and reverse_order is true, then 12345 -> 12** Corresponds to the JSON property reverseOrder

Returns:

  • (Boolean) 


536
537
538
 
# File 'generated/google/apis/dlp_v2/classes.rb', line 536

def reverse_order
  @reverse_order
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



544
545
546
547
548
549
 
# File 'generated/google/apis/dlp_v2/classes.rb', line 544

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