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/storage.proto 18 19 package com.google.privacy.dlp.v2; 20 21 public interface CustomInfoTypeOrBuilder 22 extends 23 // @@protoc_insertion_point(interface_extends:google.privacy.dlp.v2.CustomInfoType) 24 com.google.protobuf.MessageOrBuilder { 25 26 /** 27 * 28 * 29 * <pre> 30 * CustomInfoType can either be a new infoType, or an extension of built-in 31 * infoType, when the name matches one of existing infoTypes and that infoType 32 * is specified in `InspectContent.info_types` field. Specifying the latter 33 * adds findings to the one detected by the system. If built-in info type is 34 * not specified in `InspectContent.info_types` list then the name is treated 35 * as a custom info type. 36 * </pre> 37 * 38 * <code>.google.privacy.dlp.v2.InfoType info_type = 1;</code> 39 * 40 * @return Whether the infoType field is set. 41 */ hasInfoType()42 boolean hasInfoType(); 43 /** 44 * 45 * 46 * <pre> 47 * CustomInfoType can either be a new infoType, or an extension of built-in 48 * infoType, when the name matches one of existing infoTypes and that infoType 49 * is specified in `InspectContent.info_types` field. Specifying the latter 50 * adds findings to the one detected by the system. If built-in info type is 51 * not specified in `InspectContent.info_types` list then the name is treated 52 * as a custom info type. 53 * </pre> 54 * 55 * <code>.google.privacy.dlp.v2.InfoType info_type = 1;</code> 56 * 57 * @return The infoType. 58 */ getInfoType()59 com.google.privacy.dlp.v2.InfoType getInfoType(); 60 /** 61 * 62 * 63 * <pre> 64 * CustomInfoType can either be a new infoType, or an extension of built-in 65 * infoType, when the name matches one of existing infoTypes and that infoType 66 * is specified in `InspectContent.info_types` field. Specifying the latter 67 * adds findings to the one detected by the system. If built-in info type is 68 * not specified in `InspectContent.info_types` list then the name is treated 69 * as a custom info type. 70 * </pre> 71 * 72 * <code>.google.privacy.dlp.v2.InfoType info_type = 1;</code> 73 */ getInfoTypeOrBuilder()74 com.google.privacy.dlp.v2.InfoTypeOrBuilder getInfoTypeOrBuilder(); 75 76 /** 77 * 78 * 79 * <pre> 80 * Likelihood to return for this CustomInfoType. This base value can be 81 * altered by a detection rule if the finding meets the criteria specified by 82 * the rule. Defaults to `VERY_LIKELY` if not specified. 83 * </pre> 84 * 85 * <code>.google.privacy.dlp.v2.Likelihood likelihood = 6;</code> 86 * 87 * @return The enum numeric value on the wire for likelihood. 88 */ getLikelihoodValue()89 int getLikelihoodValue(); 90 /** 91 * 92 * 93 * <pre> 94 * Likelihood to return for this CustomInfoType. This base value can be 95 * altered by a detection rule if the finding meets the criteria specified by 96 * the rule. Defaults to `VERY_LIKELY` if not specified. 97 * </pre> 98 * 99 * <code>.google.privacy.dlp.v2.Likelihood likelihood = 6;</code> 100 * 101 * @return The likelihood. 102 */ getLikelihood()103 com.google.privacy.dlp.v2.Likelihood getLikelihood(); 104 105 /** 106 * 107 * 108 * <pre> 109 * A list of phrases to detect as a CustomInfoType. 110 * </pre> 111 * 112 * <code>.google.privacy.dlp.v2.CustomInfoType.Dictionary dictionary = 2;</code> 113 * 114 * @return Whether the dictionary field is set. 115 */ hasDictionary()116 boolean hasDictionary(); 117 /** 118 * 119 * 120 * <pre> 121 * A list of phrases to detect as a CustomInfoType. 122 * </pre> 123 * 124 * <code>.google.privacy.dlp.v2.CustomInfoType.Dictionary dictionary = 2;</code> 125 * 126 * @return The dictionary. 127 */ getDictionary()128 com.google.privacy.dlp.v2.CustomInfoType.Dictionary getDictionary(); 129 /** 130 * 131 * 132 * <pre> 133 * A list of phrases to detect as a CustomInfoType. 134 * </pre> 135 * 136 * <code>.google.privacy.dlp.v2.CustomInfoType.Dictionary dictionary = 2;</code> 137 */ getDictionaryOrBuilder()138 com.google.privacy.dlp.v2.CustomInfoType.DictionaryOrBuilder getDictionaryOrBuilder(); 139 140 /** 141 * 142 * 143 * <pre> 144 * Regular expression based CustomInfoType. 145 * </pre> 146 * 147 * <code>.google.privacy.dlp.v2.CustomInfoType.Regex regex = 3;</code> 148 * 149 * @return Whether the regex field is set. 150 */ hasRegex()151 boolean hasRegex(); 152 /** 153 * 154 * 155 * <pre> 156 * Regular expression based CustomInfoType. 157 * </pre> 158 * 159 * <code>.google.privacy.dlp.v2.CustomInfoType.Regex regex = 3;</code> 160 * 161 * @return The regex. 162 */ getRegex()163 com.google.privacy.dlp.v2.CustomInfoType.Regex getRegex(); 164 /** 165 * 166 * 167 * <pre> 168 * Regular expression based CustomInfoType. 169 * </pre> 170 * 171 * <code>.google.privacy.dlp.v2.CustomInfoType.Regex regex = 3;</code> 172 */ getRegexOrBuilder()173 com.google.privacy.dlp.v2.CustomInfoType.RegexOrBuilder getRegexOrBuilder(); 174 175 /** 176 * 177 * 178 * <pre> 179 * Message for detecting output from deidentification transformations that 180 * support reversing. 181 * </pre> 182 * 183 * <code>.google.privacy.dlp.v2.CustomInfoType.SurrogateType surrogate_type = 4;</code> 184 * 185 * @return Whether the surrogateType field is set. 186 */ hasSurrogateType()187 boolean hasSurrogateType(); 188 /** 189 * 190 * 191 * <pre> 192 * Message for detecting output from deidentification transformations that 193 * support reversing. 194 * </pre> 195 * 196 * <code>.google.privacy.dlp.v2.CustomInfoType.SurrogateType surrogate_type = 4;</code> 197 * 198 * @return The surrogateType. 199 */ getSurrogateType()200 com.google.privacy.dlp.v2.CustomInfoType.SurrogateType getSurrogateType(); 201 /** 202 * 203 * 204 * <pre> 205 * Message for detecting output from deidentification transformations that 206 * support reversing. 207 * </pre> 208 * 209 * <code>.google.privacy.dlp.v2.CustomInfoType.SurrogateType surrogate_type = 4;</code> 210 */ getSurrogateTypeOrBuilder()211 com.google.privacy.dlp.v2.CustomInfoType.SurrogateTypeOrBuilder getSurrogateTypeOrBuilder(); 212 213 /** 214 * 215 * 216 * <pre> 217 * Load an existing `StoredInfoType` resource for use in 218 * `InspectDataSource`. Not currently supported in `InspectContent`. 219 * </pre> 220 * 221 * <code>.google.privacy.dlp.v2.StoredType stored_type = 5;</code> 222 * 223 * @return Whether the storedType field is set. 224 */ hasStoredType()225 boolean hasStoredType(); 226 /** 227 * 228 * 229 * <pre> 230 * Load an existing `StoredInfoType` resource for use in 231 * `InspectDataSource`. Not currently supported in `InspectContent`. 232 * </pre> 233 * 234 * <code>.google.privacy.dlp.v2.StoredType stored_type = 5;</code> 235 * 236 * @return The storedType. 237 */ getStoredType()238 com.google.privacy.dlp.v2.StoredType getStoredType(); 239 /** 240 * 241 * 242 * <pre> 243 * Load an existing `StoredInfoType` resource for use in 244 * `InspectDataSource`. Not currently supported in `InspectContent`. 245 * </pre> 246 * 247 * <code>.google.privacy.dlp.v2.StoredType stored_type = 5;</code> 248 */ getStoredTypeOrBuilder()249 com.google.privacy.dlp.v2.StoredTypeOrBuilder getStoredTypeOrBuilder(); 250 251 /** 252 * 253 * 254 * <pre> 255 * Set of detection rules to apply to all findings of this CustomInfoType. 256 * Rules are applied in order that they are specified. Not supported for the 257 * `surrogate_type` CustomInfoType. 258 * </pre> 259 * 260 * <code>repeated .google.privacy.dlp.v2.CustomInfoType.DetectionRule detection_rules = 7;</code> 261 */ getDetectionRulesList()262 java.util.List<com.google.privacy.dlp.v2.CustomInfoType.DetectionRule> getDetectionRulesList(); 263 /** 264 * 265 * 266 * <pre> 267 * Set of detection rules to apply to all findings of this CustomInfoType. 268 * Rules are applied in order that they are specified. Not supported for the 269 * `surrogate_type` CustomInfoType. 270 * </pre> 271 * 272 * <code>repeated .google.privacy.dlp.v2.CustomInfoType.DetectionRule detection_rules = 7;</code> 273 */ getDetectionRules(int index)274 com.google.privacy.dlp.v2.CustomInfoType.DetectionRule getDetectionRules(int index); 275 /** 276 * 277 * 278 * <pre> 279 * Set of detection rules to apply to all findings of this CustomInfoType. 280 * Rules are applied in order that they are specified. Not supported for the 281 * `surrogate_type` CustomInfoType. 282 * </pre> 283 * 284 * <code>repeated .google.privacy.dlp.v2.CustomInfoType.DetectionRule detection_rules = 7;</code> 285 */ getDetectionRulesCount()286 int getDetectionRulesCount(); 287 /** 288 * 289 * 290 * <pre> 291 * Set of detection rules to apply to all findings of this CustomInfoType. 292 * Rules are applied in order that they are specified. Not supported for the 293 * `surrogate_type` CustomInfoType. 294 * </pre> 295 * 296 * <code>repeated .google.privacy.dlp.v2.CustomInfoType.DetectionRule detection_rules = 7;</code> 297 */ 298 java.util.List<? extends com.google.privacy.dlp.v2.CustomInfoType.DetectionRuleOrBuilder> getDetectionRulesOrBuilderList()299 getDetectionRulesOrBuilderList(); 300 /** 301 * 302 * 303 * <pre> 304 * Set of detection rules to apply to all findings of this CustomInfoType. 305 * Rules are applied in order that they are specified. Not supported for the 306 * `surrogate_type` CustomInfoType. 307 * </pre> 308 * 309 * <code>repeated .google.privacy.dlp.v2.CustomInfoType.DetectionRule detection_rules = 7;</code> 310 */ getDetectionRulesOrBuilder( int index)311 com.google.privacy.dlp.v2.CustomInfoType.DetectionRuleOrBuilder getDetectionRulesOrBuilder( 312 int index); 313 314 /** 315 * 316 * 317 * <pre> 318 * If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding 319 * to be returned. It still can be used for rules matching. 320 * </pre> 321 * 322 * <code>.google.privacy.dlp.v2.CustomInfoType.ExclusionType exclusion_type = 8;</code> 323 * 324 * @return The enum numeric value on the wire for exclusionType. 325 */ getExclusionTypeValue()326 int getExclusionTypeValue(); 327 /** 328 * 329 * 330 * <pre> 331 * If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding 332 * to be returned. It still can be used for rules matching. 333 * </pre> 334 * 335 * <code>.google.privacy.dlp.v2.CustomInfoType.ExclusionType exclusion_type = 8;</code> 336 * 337 * @return The exclusionType. 338 */ getExclusionType()339 com.google.privacy.dlp.v2.CustomInfoType.ExclusionType getExclusionType(); 340 getTypeCase()341 public com.google.privacy.dlp.v2.CustomInfoType.TypeCase getTypeCase(); 342 } 343