Package com.google.privacy.dlp.v2

Class CharacterMaskConfig

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.privacy.dlp.v2.CharacterMaskConfig
All Implemented Interfaces:
CharacterMaskConfigOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class CharacterMaskConfig extends com.google.protobuf.GeneratedMessage 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
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    CharacterMaskConfig.Builder
    Partially mask a string by replacing a given number of characters with a fixed character.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

    com.google.protobuf.AbstractMessage.BuilderParent

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    CHARACTERS_TO_IGNORE_FIELD_NUMBER
     
    static final int
    MASKING_CHARACTER_FIELD_NUMBER
     
    static final int
    NUMBER_TO_MASK_FIELD_NUMBER
     
    static final int
    REVERSE_ORDER_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    CharsToIgnore
    getCharactersToIgnore(int index)
    When masking a string, items in this list will be skipped when replacing characters.
    int
    getCharactersToIgnoreCount()
    When masking a string, items in this list will be skipped when replacing characters.
    List<CharsToIgnore>
    getCharactersToIgnoreList()
    When masking a string, items in this list will be skipped when replacing characters.
    CharsToIgnoreOrBuilder
    getCharactersToIgnoreOrBuilder(int index)
    When masking a string, items in this list will be skipped when replacing characters.
    List<? extends CharsToIgnoreOrBuilder>
    getCharactersToIgnoreOrBuilderList()
    When masking a string, items in this list will be skipped when replacing characters.
    static CharacterMaskConfig
    getDefaultInstance()
     
    CharacterMaskConfig
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    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.
    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.
    int
    getNumberToMask()
    Number of characters to mask.
    com.google.protobuf.Parser<CharacterMaskConfig>
    getParserForType()
     
    boolean
    getReverseOrder()
    Mask characters in reverse order.
    int
    getSerializedSize()
     
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static CharacterMaskConfig.Builder
    newBuilder()
     
    static CharacterMaskConfig.Builder
    newBuilder(CharacterMaskConfig prototype)
     
    CharacterMaskConfig.Builder
    newBuilderForType()
     
    protected CharacterMaskConfig.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static CharacterMaskConfig
    parseDelimitedFrom(InputStream input)
     
    static CharacterMaskConfig
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static CharacterMaskConfig
    parseFrom(byte[] data)
     
    static CharacterMaskConfig
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static CharacterMaskConfig
    parseFrom(com.google.protobuf.ByteString data)
     
    static CharacterMaskConfig
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static CharacterMaskConfig
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static CharacterMaskConfig
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static CharacterMaskConfig
    parseFrom(InputStream input)
     
    static CharacterMaskConfig
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static CharacterMaskConfig
    parseFrom(ByteBuffer data)
     
    static CharacterMaskConfig
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<CharacterMaskConfig>
    parser()
     
    CharacterMaskConfig.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Field Details

    • MASKING_CHARACTER_FIELD_NUMBER

      public static final int MASKING_CHARACTER_FIELD_NUMBER
      See Also:

    • NUMBER_TO_MASK_FIELD_NUMBER

      public static final int NUMBER_TO_MASK_FIELD_NUMBER
      See Also:

    • REVERSE_ORDER_FIELD_NUMBER

      public static final int REVERSE_ORDER_FIELD_NUMBER
      See Also:

    • CHARACTERS_TO_IGNORE_FIELD_NUMBER

      public static final int CHARACTERS_TO_IGNORE_FIELD_NUMBER
      See Also:

  • 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

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

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

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

    • 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

    • 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

    • 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

    • 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

    • isInitialized

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

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static CharacterMaskConfig parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static CharacterMaskConfig parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static CharacterMaskConfig parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static CharacterMaskConfig parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static CharacterMaskConfig parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static CharacterMaskConfig parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static CharacterMaskConfig parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static CharacterMaskConfig parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static CharacterMaskConfig parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static CharacterMaskConfig parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static CharacterMaskConfig parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static CharacterMaskConfig parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

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

    • newBuilder

      public static CharacterMaskConfig.Builder newBuilder()

    • newBuilder

      public static CharacterMaskConfig.Builder newBuilder(CharacterMaskConfig prototype)

    • toBuilder

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

    • newBuilderForType

      protected CharacterMaskConfig.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static CharacterMaskConfig getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<CharacterMaskConfig> parser()

    • getParserForType

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

    • getDefaultInstanceForType

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