com.google.api.services.dlp.v2.model

Class GooglePrivacyDlpV2CharacterMaskConfig

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.dlp.v2.model.GooglePrivacyDlpV2CharacterMaskConfig

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class GooglePrivacyDlpV2CharacterMaskConfig
extends GenericJson

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.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Cloud Data Loss Prevention (DLP) API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
GooglePrivacyDlpV2CharacterMaskConfig()

Method Summary

Modifier and Type	Method and Description
GooglePrivacyDlpV2CharacterMaskConfig	clone()
List<GooglePrivacyDlpV2CharsToIgnore>	getCharactersToIgnore() When masking a string, items in this list will be skipped when replacing characters.
String	getMaskingCharacter() 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.
Integer	getNumberToMask() Number of characters to mask.
Boolean	getReverseOrder() Mask characters in reverse order.
GooglePrivacyDlpV2CharacterMaskConfig	set(String fieldName, Object value)
GooglePrivacyDlpV2CharacterMaskConfig	setCharactersToIgnore(List<GooglePrivacyDlpV2CharsToIgnore> charactersToIgnore) When masking a string, items in this list will be skipped when replacing characters.
GooglePrivacyDlpV2CharacterMaskConfig	setMaskingCharacter(String maskingCharacter) 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.
GooglePrivacyDlpV2CharacterMaskConfig	setNumberToMask(Integer numberToMask) Number of characters to mask.
GooglePrivacyDlpV2CharacterMaskConfig	setReverseOrder(Boolean reverseOrder) Mask characters in reverse order.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

GooglePrivacyDlpV2CharacterMaskConfig

public GooglePrivacyDlpV2CharacterMaskConfig()

Method Detail

getCharactersToIgnore

public List<GooglePrivacyDlpV2CharsToIgnore> getCharactersToIgnore()

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:

value or null for none

setCharactersToIgnore

public GooglePrivacyDlpV2CharacterMaskConfig setCharactersToIgnore(List<GooglePrivacyDlpV2CharsToIgnore> charactersToIgnore)

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`.

Parameters:

charactersToIgnore - charactersToIgnore or null for none

getMaskingCharacter

public String getMaskingCharacter()

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.

Returns:

value or null for none

setMaskingCharacter

public GooglePrivacyDlpV2CharacterMaskConfig setMaskingCharacter(String maskingCharacter)

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.

Parameters:

maskingCharacter - maskingCharacter or null for none

getNumberToMask

public Integer getNumberToMask()

Number of characters to mask. If not set, all matching chars will be masked. Skipped characters do not count towards this tally.

Returns:

value or null for none

setNumberToMask

public GooglePrivacyDlpV2CharacterMaskConfig setNumberToMask(Integer numberToMask)

Number of characters to mask. If not set, all matching chars will be masked. Skipped characters do not count towards this tally.

Parameters:

numberToMask - numberToMask or null for none

getReverseOrder

public Boolean getReverseOrder()

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***`.

Returns:

value or null for none

setReverseOrder

public GooglePrivacyDlpV2CharacterMaskConfig setReverseOrder(Boolean reverseOrder)

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***`.

Parameters:

reverseOrder - reverseOrder or null for none

set

public GooglePrivacyDlpV2CharacterMaskConfig set(String fieldName,
                                                 Object value)

Overrides:

set in class GenericJson

clone

public GooglePrivacyDlpV2CharacterMaskConfig clone()

Overrides:

clone in class GenericJson