Interface CharacterMaskConfigOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    CharacterMaskConfig, CharacterMaskConfig.Builder

    public interface CharacterMaskConfigOrBuilder
    extends com.google.protobuf.MessageOrBuilder
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      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.
      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.
      boolean getReverseOrder()
      Mask characters in reverse order.
      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized
      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
    • Method Detail

      • getMaskingCharacter

        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;
        Returns:
        The maskingCharacter.
      • getMaskingCharacterBytes

        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;
        Returns:
        The bytes for maskingCharacter.
      • getNumberToMask

        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;
        Returns:
        The numberToMask.
      • getReverseOrder

        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;
        Returns:
        The reverseOrder.
      • getCharactersToIgnoreList

        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;
      • getCharactersToIgnore

        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;
      • getCharactersToIgnoreCount

        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;
      • getCharactersToIgnoreOrBuilderList

        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;
      • getCharactersToIgnoreOrBuilder

        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;