Cloud Data Loss Prevention (DLP) V2 API - Class Google::Cloud::Dlp::V2::CharacterMaskConfig (v0.22.0)
Stay organized with collections
Save and categorize content based on your preferences.
Reference documentation and code samples for the Cloud Data Loss Prevention (DLP) V2 API class Google::Cloud::Dlp::V2::CharacterMaskConfig.
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.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#characters_to_ignore
defcharacters_to_ignore()->::Array<::Google::Cloud::Dlp::V2::CharsToIgnore>-
(::Array<::Google::Cloud::Dlp::V2::CharsToIgnore>) — When masking a string, items in this list will be skipped when replacing
characters. For example, if the input string is
555-555-5555and you instruct Cloud DLP to skip-and mask 5 characters with*, Cloud DLP returns***-**5-5555.
#characters_to_ignore=
defcharacters_to_ignore=(value)->::Array<::Google::Cloud::Dlp::V2::CharsToIgnore>-
value (::Array<::Google::Cloud::Dlp::V2::CharsToIgnore>) — When masking a string, items in this list will be skipped when replacing
characters. For example, if the input string is
555-555-5555and you instruct Cloud DLP to skip-and mask 5 characters with*, Cloud DLP returns***-**5-5555.
-
(::Array<::Google::Cloud::Dlp::V2::CharsToIgnore>) — When masking a string, items in this list will be skipped when replacing
characters. For example, if the input string is
555-555-5555and you instruct Cloud DLP to skip-and mask 5 characters with*, Cloud DLP returns***-**5-5555.
#masking_character
defmasking_character()->::String-
(::String) — Character to use to mask the sensitive values—for example,
*for an alphabetic string such as a name, or0for 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, and0for digits.
#masking_character=
defmasking_character=(value)->::String-
value (::String) — Character to use to mask the sensitive values—for example,
*for an alphabetic string such as a name, or0for 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, and0for digits.
-
(::String) — Character to use to mask the sensitive values—for example,
*for an alphabetic string such as a name, or0for 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, and0for digits.
#number_to_mask
defnumber_to_mask()->::Integer-
(::Integer) — 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_maskis negative, this denotes inverse masking. Cloud DLP masks all but a number of characters. For example, suppose you have the following values:masking_characteris*number_to_maskis-4reverse_orderisfalseCharsToIgnoreincludes-- Input string is
1234-5678-9012-3456
The resulting de-identified string is
****-****-****-3456. Cloud DLP masks all but the last four characters. Ifreverse_orderistrue, all but the first four characters are masked as1234-****-****-****.
#number_to_mask=
defnumber_to_mask=(value)->::Integer-
value (::Integer) — 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_maskis negative, this denotes inverse masking. Cloud DLP masks all but a number of characters. For example, suppose you have the following values:masking_characteris*number_to_maskis-4reverse_orderisfalseCharsToIgnoreincludes-- Input string is
1234-5678-9012-3456
The resulting de-identified string is
****-****-****-3456. Cloud DLP masks all but the last four characters. Ifreverse_orderistrue, all but the first four characters are masked as1234-****-****-****.
-
(::Integer) — 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_maskis negative, this denotes inverse masking. Cloud DLP masks all but a number of characters. For example, suppose you have the following values:masking_characteris*number_to_maskis-4reverse_orderisfalseCharsToIgnoreincludes-- Input string is
1234-5678-9012-3456
The resulting de-identified string is
****-****-****-3456. Cloud DLP masks all but the last four characters. Ifreverse_orderistrue, all but the first four characters are masked as1234-****-****-****.
#reverse_order
defreverse_order()->::Boolean-
(::Boolean) — Mask characters in reverse order. For example, if
masking_characteris0,number_to_maskis14, andreverse_orderisfalse, then the input string1234-5678-9012-3456is masked as00000000000000-3456. Ifmasking_characteris*,number_to_maskis3, andreverse_orderistrue, then the string12345is masked as12***.
#reverse_order=
defreverse_order=(value)->::Boolean-
value (::Boolean) — Mask characters in reverse order. For example, if
masking_characteris0,number_to_maskis14, andreverse_orderisfalse, then the input string1234-5678-9012-3456is masked as00000000000000-3456. Ifmasking_characteris*,number_to_maskis3, andreverse_orderistrue, then the string12345is masked as12***.
-
(::Boolean) — Mask characters in reverse order. For example, if
masking_characteris0,number_to_maskis14, andreverse_orderisfalse, then the input string1234-5678-9012-3456is masked as00000000000000-3456. Ifmasking_characteris*,number_to_maskis3, andreverse_orderistrue, then the string12345is masked as12***.