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
def characters_to_ignore() -> ::Array<::Google::Cloud::Dlp::V2::CharsToIgnore>
Returns
-
(::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-5555
and you instruct Cloud DLP to skip-
and mask 5 characters with*
, Cloud DLP returns***-**5-5555
.
#characters_to_ignore=
def characters_to_ignore=(value) -> ::Array<::Google::Cloud::Dlp::V2::CharsToIgnore>
Parameter
-
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-5555
and you instruct Cloud DLP to skip-
and mask 5 characters with*
, Cloud DLP returns***-**5-5555
.
Returns
-
(::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-5555
and you instruct Cloud DLP to skip-
and mask 5 characters with*
, Cloud DLP returns***-**5-5555
.
#masking_character
def masking_character() -> ::String
Returns
-
(::String) — Character to use to mask the sensitive values—for example,
*
for an alphabetic string such as a name, or0
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, and0
for digits.
#masking_character=
def masking_character=(value) -> ::String
Parameter
-
value (::String) — Character to use to mask the sensitive values—for example,
*
for an alphabetic string such as a name, or0
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, and0
for digits.
Returns
-
(::String) — Character to use to mask the sensitive values—for example,
*
for an alphabetic string such as a name, or0
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, and0
for digits.
#number_to_mask
def number_to_mask() -> ::Integer
Returns
- (::Integer) — Number of characters to mask. If not set, all matching chars will be masked. Skipped characters do not count towards this tally.
#number_to_mask=
def number_to_mask=(value) -> ::Integer
Parameter
- value (::Integer) — Number of characters to mask. If not set, all matching chars will be masked. Skipped characters do not count towards this tally.
Returns
- (::Integer) — Number of characters to mask. If not set, all matching chars will be masked. Skipped characters do not count towards this tally.
#reverse_order
def reverse_order() -> ::Boolean
Returns
-
(::Boolean) — Mask characters in reverse order. For example, if
masking_character
is0
,number_to_mask
is14
, andreverse_order
isfalse
, then the input string1234-5678-9012-3456
is masked as00000000000000-3456
. Ifmasking_character
is*
,number_to_mask
is3
, andreverse_order
istrue
, then the string12345
is masked as12***
.
#reverse_order=
def reverse_order=(value) -> ::Boolean
Parameter
-
value (::Boolean) — Mask characters in reverse order. For example, if
masking_character
is0
,number_to_mask
is14
, andreverse_order
isfalse
, then the input string1234-5678-9012-3456
is masked as00000000000000-3456
. Ifmasking_character
is*
,number_to_mask
is3
, andreverse_order
istrue
, then the string12345
is masked as12***
.
Returns
-
(::Boolean) — Mask characters in reverse order. For example, if
masking_character
is0
,number_to_mask
is14
, andreverse_order
isfalse
, then the input string1234-5678-9012-3456
is masked as00000000000000-3456
. Ifmasking_character
is*
,number_to_mask
is3
, andreverse_order
istrue
, then the string12345
is masked as12***
.