1 /* 2 * Copyright 2020 Google LLC 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * https://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 // Generated by the protocol buffer compiler. DO NOT EDIT! 17 // source: google/privacy/dlp/v2/dlp.proto 18 19 package com.google.privacy.dlp.v2; 20 21 public interface CharacterMaskConfigOrBuilder 22 extends 23 // @@protoc_insertion_point(interface_extends:google.privacy.dlp.v2.CharacterMaskConfig) 24 com.google.protobuf.MessageOrBuilder { 25 26 /** 27 * 28 * 29 * <pre> 30 * Character to use to mask the sensitive values&mdash;for example, `*` for an 31 * alphabetic string such as a name, or `0` for a numeric string such as ZIP 32 * code or credit card number. This string must have a length of 1. If not 33 * supplied, this value defaults to `*` for strings, and `0` for digits. 34 * </pre> 35 * 36 * <code>string masking_character = 1;</code> 37 * 38 * @return The maskingCharacter. 39 */ getMaskingCharacter()40 java.lang.String getMaskingCharacter(); 41 /** 42 * 43 * 44 * <pre> 45 * Character to use to mask the sensitive values&mdash;for example, `*` for an 46 * alphabetic string such as a name, or `0` for a numeric string such as ZIP 47 * code or credit card number. This string must have a length of 1. If not 48 * supplied, this value defaults to `*` for strings, and `0` for digits. 49 * </pre> 50 * 51 * <code>string masking_character = 1;</code> 52 * 53 * @return The bytes for maskingCharacter. 54 */ getMaskingCharacterBytes()55 com.google.protobuf.ByteString getMaskingCharacterBytes(); 56 57 /** 58 * 59 * 60 * <pre> 61 * Number of characters to mask. If not set, all matching chars will be 62 * masked. Skipped characters do not count towards this tally. 63 * If `number_to_mask` is negative, this denotes inverse masking. Cloud DLP 64 * masks all but a number of characters. 65 * For example, suppose you have the following values: 66 * - `masking_character` is `*` 67 * - `number_to_mask` is `-4` 68 * - `reverse_order` is `false` 69 * - `CharsToIgnore` includes `-` 70 * - Input string is `1234-5678-9012-3456` 71 * The resulting de-identified string is 72 * `****-****-****-3456`. Cloud DLP masks all but the last four characters. 73 * If `reverse_order` is `true`, all but the first four characters are masked 74 * as `1234-****-****-****`. 75 * </pre> 76 * 77 * <code>int32 number_to_mask = 2;</code> 78 * 79 * @return The numberToMask. 80 */ getNumberToMask()81 int getNumberToMask(); 82 83 /** 84 * 85 * 86 * <pre> 87 * Mask characters in reverse order. For example, if `masking_character` is 88 * `0`, `number_to_mask` is `14`, and `reverse_order` is `false`, then the 89 * input string `1234-5678-9012-3456` is masked as `00000000000000-3456`. 90 * If `masking_character` is `*`, `number_to_mask` is `3`, and `reverse_order` 91 * is `true`, then the string `12345` is masked as `12***`. 92 * </pre> 93 * 94 * <code>bool reverse_order = 3;</code> 95 * 96 * @return The reverseOrder. 97 */ getReverseOrder()98 boolean getReverseOrder(); 99 100 /** 101 * 102 * 103 * <pre> 104 * When masking a string, items in this list will be skipped when replacing 105 * characters. For example, if the input string is `555-555-5555` and you 106 * instruct Cloud DLP to skip `-` and mask 5 characters with `*`, Cloud DLP 107 * returns `***-**5-5555`. 108 * </pre> 109 * 110 * <code>repeated .google.privacy.dlp.v2.CharsToIgnore characters_to_ignore = 4;</code> 111 */ getCharactersToIgnoreList()112 java.util.List<com.google.privacy.dlp.v2.CharsToIgnore> getCharactersToIgnoreList(); 113 /** 114 * 115 * 116 * <pre> 117 * When masking a string, items in this list will be skipped when replacing 118 * characters. For example, if the input string is `555-555-5555` and you 119 * instruct Cloud DLP to skip `-` and mask 5 characters with `*`, Cloud DLP 120 * returns `***-**5-5555`. 121 * </pre> 122 * 123 * <code>repeated .google.privacy.dlp.v2.CharsToIgnore characters_to_ignore = 4;</code> 124 */ getCharactersToIgnore(int index)125 com.google.privacy.dlp.v2.CharsToIgnore getCharactersToIgnore(int index); 126 /** 127 * 128 * 129 * <pre> 130 * When masking a string, items in this list will be skipped when replacing 131 * characters. For example, if the input string is `555-555-5555` and you 132 * instruct Cloud DLP to skip `-` and mask 5 characters with `*`, Cloud DLP 133 * returns `***-**5-5555`. 134 * </pre> 135 * 136 * <code>repeated .google.privacy.dlp.v2.CharsToIgnore characters_to_ignore = 4;</code> 137 */ getCharactersToIgnoreCount()138 int getCharactersToIgnoreCount(); 139 /** 140 * 141 * 142 * <pre> 143 * When masking a string, items in this list will be skipped when replacing 144 * characters. For example, if the input string is `555-555-5555` and you 145 * instruct Cloud DLP to skip `-` and mask 5 characters with `*`, Cloud DLP 146 * returns `***-**5-5555`. 147 * </pre> 148 * 149 * <code>repeated .google.privacy.dlp.v2.CharsToIgnore characters_to_ignore = 4;</code> 150 */ 151 java.util.List<? extends com.google.privacy.dlp.v2.CharsToIgnoreOrBuilder> getCharactersToIgnoreOrBuilderList()152 getCharactersToIgnoreOrBuilderList(); 153 /** 154 * 155 * 156 * <pre> 157 * When masking a string, items in this list will be skipped when replacing 158 * characters. For example, if the input string is `555-555-5555` and you 159 * instruct Cloud DLP to skip `-` and mask 5 characters with `*`, Cloud DLP 160 * returns `***-**5-5555`. 161 * </pre> 162 * 163 * <code>repeated .google.privacy.dlp.v2.CharsToIgnore characters_to_ignore = 4;</code> 164 */ getCharactersToIgnoreOrBuilder(int index)165 com.google.privacy.dlp.v2.CharsToIgnoreOrBuilder getCharactersToIgnoreOrBuilder(int index); 166 } 167