Package com.google.privacy.dlp.v2

Class CharacterMaskConfig.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<CharacterMaskConfig.Builder>
com.google.privacy.dlp.v2.CharacterMaskConfig.Builder
All Implemented Interfaces:
CharacterMaskConfigOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
CharacterMaskConfig
public static final class CharacterMaskConfig.Builder extends com.google.protobuf.GeneratedMessage.Builder<CharacterMaskConfig.Builder> implements CharacterMaskConfigOrBuilder
 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.
Protobuf type google.privacy.dlp.v2.CharacterMaskConfig

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<CharacterMaskConfig.Builder>

    • clear

      public CharacterMaskConfig.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<CharacterMaskConfig.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<CharacterMaskConfig.Builder>

    • getDefaultInstanceForType

      public CharacterMaskConfig getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

      public CharacterMaskConfig build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public CharacterMaskConfig buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • mergeFrom

      public CharacterMaskConfig.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<CharacterMaskConfig.Builder>

    • mergeFrom

      public CharacterMaskConfig.Builder mergeFrom(CharacterMaskConfig other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<CharacterMaskConfig.Builder>

    • mergeFrom

      public CharacterMaskConfig.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<CharacterMaskConfig.Builder>
      Throws:
      IOException

    • getMaskingCharacter

      public String getMaskingCharacter()
       Character to use to mask the sensitive values&mdash;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.
      string masking_character = 1;
      Specified by:
      getMaskingCharacter in interface CharacterMaskConfigOrBuilder
      Returns:
      The maskingCharacter.

    • getMaskingCharacterBytes

      public com.google.protobuf.ByteString getMaskingCharacterBytes()
       Character to use to mask the sensitive values&mdash;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.
      string masking_character = 1;
      Specified by:
      getMaskingCharacterBytes in interface CharacterMaskConfigOrBuilder
      Returns:
      The bytes for maskingCharacter.

    • setMaskingCharacter

      public CharacterMaskConfig.Builder setMaskingCharacter(String value)
       Character to use to mask the sensitive values&mdash;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.
      string masking_character = 1;
      Parameters:
      value - The maskingCharacter to set.
      Returns:
      This builder for chaining.

    • clearMaskingCharacter

      public CharacterMaskConfig.Builder clearMaskingCharacter()
       Character to use to mask the sensitive values&mdash;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.
      string masking_character = 1;
      Returns:
      This builder for chaining.

    • setMaskingCharacterBytes

      public CharacterMaskConfig.Builder setMaskingCharacterBytes(com.google.protobuf.ByteString value)
       Character to use to mask the sensitive values&mdash;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.
      string masking_character = 1;
      Parameters:
      value - The bytes for maskingCharacter to set.
      Returns:
      This builder for chaining.

    • getNumberToMask

      public int getNumberToMask()
       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-****-****-****`.
      int32 number_to_mask = 2;
      Specified by:
      getNumberToMask in interface CharacterMaskConfigOrBuilder
      Returns:
      The numberToMask.

    • setNumberToMask

      public CharacterMaskConfig.Builder setNumberToMask(int value)
       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-****-****-****`.
      int32 number_to_mask = 2;
      Parameters:
      value - The numberToMask to set.
      Returns:
      This builder for chaining.

    • clearNumberToMask

      public CharacterMaskConfig.Builder clearNumberToMask()
       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-****-****-****`.
      int32 number_to_mask = 2;
      Returns:
      This builder for chaining.

    • 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***`.
      bool reverse_order = 3;
      Specified by:
      getReverseOrder in interface CharacterMaskConfigOrBuilder
      Returns:
      The reverseOrder.

    • setReverseOrder

      public CharacterMaskConfig.Builder setReverseOrder(boolean value)
       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***`.
      bool reverse_order = 3;
      Parameters:
      value - The reverseOrder to set.
      Returns:
      This builder for chaining.

    • clearReverseOrder

      public CharacterMaskConfig.Builder clearReverseOrder()
       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***`.
      bool reverse_order = 3;
      Returns:
      This builder for chaining.

    • getCharactersToIgnoreList

      public List<CharsToIgnore> getCharactersToIgnoreList()
       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`.
      repeated .google.privacy.dlp.v2.CharsToIgnore characters_to_ignore = 4;
      Specified by:
      getCharactersToIgnoreList in interface CharacterMaskConfigOrBuilder

    • getCharactersToIgnoreCount

      public int getCharactersToIgnoreCount()
       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`.
      repeated .google.privacy.dlp.v2.CharsToIgnore characters_to_ignore = 4;
      Specified by:
      getCharactersToIgnoreCount in interface CharacterMaskConfigOrBuilder

    • getCharactersToIgnore

      public CharsToIgnore getCharactersToIgnore(int index)
       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`.
      repeated .google.privacy.dlp.v2.CharsToIgnore characters_to_ignore = 4;
      Specified by:
      getCharactersToIgnore in interface CharacterMaskConfigOrBuilder

    • setCharactersToIgnore

      public CharacterMaskConfig.Builder setCharactersToIgnore(int index, CharsToIgnore value)
       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`.
      repeated .google.privacy.dlp.v2.CharsToIgnore characters_to_ignore = 4;

    • setCharactersToIgnore

      public CharacterMaskConfig.Builder setCharactersToIgnore(int index, CharsToIgnore.Builder builderForValue)
       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`.
      repeated .google.privacy.dlp.v2.CharsToIgnore characters_to_ignore = 4;

    • addCharactersToIgnore

      public CharacterMaskConfig.Builder addCharactersToIgnore(CharsToIgnore value)
       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`.
      repeated .google.privacy.dlp.v2.CharsToIgnore characters_to_ignore = 4;

    • addCharactersToIgnore

      public CharacterMaskConfig.Builder addCharactersToIgnore(int index, CharsToIgnore value)
       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`.
      repeated .google.privacy.dlp.v2.CharsToIgnore characters_to_ignore = 4;

    • addCharactersToIgnore

      public CharacterMaskConfig.Builder addCharactersToIgnore(CharsToIgnore.Builder builderForValue)
       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`.
      repeated .google.privacy.dlp.v2.CharsToIgnore characters_to_ignore = 4;

    • addCharactersToIgnore

      public CharacterMaskConfig.Builder addCharactersToIgnore(int index, CharsToIgnore.Builder builderForValue)
       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`.
      repeated .google.privacy.dlp.v2.CharsToIgnore characters_to_ignore = 4;

    • addAllCharactersToIgnore

      public CharacterMaskConfig.Builder addAllCharactersToIgnore(Iterable<? extends CharsToIgnore> values)
       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`.
      repeated .google.privacy.dlp.v2.CharsToIgnore characters_to_ignore = 4;

    • clearCharactersToIgnore

      public CharacterMaskConfig.Builder clearCharactersToIgnore()
       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`.
      repeated .google.privacy.dlp.v2.CharsToIgnore characters_to_ignore = 4;

    • removeCharactersToIgnore

      public CharacterMaskConfig.Builder removeCharactersToIgnore(int index)
       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`.
      repeated .google.privacy.dlp.v2.CharsToIgnore characters_to_ignore = 4;

    • getCharactersToIgnoreBuilder

      public CharsToIgnore.Builder getCharactersToIgnoreBuilder(int index)
       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`.
      repeated .google.privacy.dlp.v2.CharsToIgnore characters_to_ignore = 4;

    • getCharactersToIgnoreOrBuilder

      public CharsToIgnoreOrBuilder getCharactersToIgnoreOrBuilder(int index)
       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`.
      repeated .google.privacy.dlp.v2.CharsToIgnore characters_to_ignore = 4;
      Specified by:
      getCharactersToIgnoreOrBuilder in interface CharacterMaskConfigOrBuilder

    • getCharactersToIgnoreOrBuilderList

      public List<? extends CharsToIgnoreOrBuilder> getCharactersToIgnoreOrBuilderList()
       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`.
      repeated .google.privacy.dlp.v2.CharsToIgnore characters_to_ignore = 4;
      Specified by:
      getCharactersToIgnoreOrBuilderList in interface CharacterMaskConfigOrBuilder

    • addCharactersToIgnoreBuilder

      public CharsToIgnore.Builder addCharactersToIgnoreBuilder()
       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`.
      repeated .google.privacy.dlp.v2.CharsToIgnore characters_to_ignore = 4;

    • addCharactersToIgnoreBuilder

      public CharsToIgnore.Builder addCharactersToIgnoreBuilder(int index)
       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`.
      repeated .google.privacy.dlp.v2.CharsToIgnore characters_to_ignore = 4;

    • getCharactersToIgnoreBuilderList

      public List<CharsToIgnore.Builder> getCharactersToIgnoreBuilderList()
       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`.
      repeated .google.privacy.dlp.v2.CharsToIgnore characters_to_ignore = 4;