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 InspectConfigOrBuilder 22 extends 23 // @@protoc_insertion_point(interface_extends:google.privacy.dlp.v2.InspectConfig) 24 com.google.protobuf.MessageOrBuilder { 25 26 /** 27 * 28 * 29 * <pre> 30 * Restricts what info_types to look for. The values must correspond to 31 * InfoType values returned by ListInfoTypes or listed at 32 * https://cloud.google.com/dlp/docs/infotypes-reference. 33 * When no InfoTypes or CustomInfoTypes are specified in a request, the 34 * system may automatically choose what detectors to run. By default this may 35 * be all types, but may change over time as detectors are updated. 36 * If you need precise control and predictability as to what detectors are 37 * run you should specify specific InfoTypes listed in the reference, 38 * otherwise a default list will be used, which may change over time. 39 * </pre> 40 * 41 * <code>repeated .google.privacy.dlp.v2.InfoType info_types = 1;</code> 42 */ getInfoTypesList()43 java.util.List<com.google.privacy.dlp.v2.InfoType> getInfoTypesList(); 44 /** 45 * 46 * 47 * <pre> 48 * Restricts what info_types to look for. The values must correspond to 49 * InfoType values returned by ListInfoTypes or listed at 50 * https://cloud.google.com/dlp/docs/infotypes-reference. 51 * When no InfoTypes or CustomInfoTypes are specified in a request, the 52 * system may automatically choose what detectors to run. By default this may 53 * be all types, but may change over time as detectors are updated. 54 * If you need precise control and predictability as to what detectors are 55 * run you should specify specific InfoTypes listed in the reference, 56 * otherwise a default list will be used, which may change over time. 57 * </pre> 58 * 59 * <code>repeated .google.privacy.dlp.v2.InfoType info_types = 1;</code> 60 */ getInfoTypes(int index)61 com.google.privacy.dlp.v2.InfoType getInfoTypes(int index); 62 /** 63 * 64 * 65 * <pre> 66 * Restricts what info_types to look for. The values must correspond to 67 * InfoType values returned by ListInfoTypes or listed at 68 * https://cloud.google.com/dlp/docs/infotypes-reference. 69 * When no InfoTypes or CustomInfoTypes are specified in a request, the 70 * system may automatically choose what detectors to run. By default this may 71 * be all types, but may change over time as detectors are updated. 72 * If you need precise control and predictability as to what detectors are 73 * run you should specify specific InfoTypes listed in the reference, 74 * otherwise a default list will be used, which may change over time. 75 * </pre> 76 * 77 * <code>repeated .google.privacy.dlp.v2.InfoType info_types = 1;</code> 78 */ getInfoTypesCount()79 int getInfoTypesCount(); 80 /** 81 * 82 * 83 * <pre> 84 * Restricts what info_types to look for. The values must correspond to 85 * InfoType values returned by ListInfoTypes or listed at 86 * https://cloud.google.com/dlp/docs/infotypes-reference. 87 * When no InfoTypes or CustomInfoTypes are specified in a request, the 88 * system may automatically choose what detectors to run. By default this may 89 * be all types, but may change over time as detectors are updated. 90 * If you need precise control and predictability as to what detectors are 91 * run you should specify specific InfoTypes listed in the reference, 92 * otherwise a default list will be used, which may change over time. 93 * </pre> 94 * 95 * <code>repeated .google.privacy.dlp.v2.InfoType info_types = 1;</code> 96 */ getInfoTypesOrBuilderList()97 java.util.List<? extends com.google.privacy.dlp.v2.InfoTypeOrBuilder> getInfoTypesOrBuilderList(); 98 /** 99 * 100 * 101 * <pre> 102 * Restricts what info_types to look for. The values must correspond to 103 * InfoType values returned by ListInfoTypes or listed at 104 * https://cloud.google.com/dlp/docs/infotypes-reference. 105 * When no InfoTypes or CustomInfoTypes are specified in a request, the 106 * system may automatically choose what detectors to run. By default this may 107 * be all types, but may change over time as detectors are updated. 108 * If you need precise control and predictability as to what detectors are 109 * run you should specify specific InfoTypes listed in the reference, 110 * otherwise a default list will be used, which may change over time. 111 * </pre> 112 * 113 * <code>repeated .google.privacy.dlp.v2.InfoType info_types = 1;</code> 114 */ getInfoTypesOrBuilder(int index)115 com.google.privacy.dlp.v2.InfoTypeOrBuilder getInfoTypesOrBuilder(int index); 116 117 /** 118 * 119 * 120 * <pre> 121 * Only returns findings equal or above this threshold. The default is 122 * POSSIBLE. 123 * See https://cloud.google.com/dlp/docs/likelihood to learn more. 124 * </pre> 125 * 126 * <code>.google.privacy.dlp.v2.Likelihood min_likelihood = 2;</code> 127 * 128 * @return The enum numeric value on the wire for minLikelihood. 129 */ getMinLikelihoodValue()130 int getMinLikelihoodValue(); 131 /** 132 * 133 * 134 * <pre> 135 * Only returns findings equal or above this threshold. The default is 136 * POSSIBLE. 137 * See https://cloud.google.com/dlp/docs/likelihood to learn more. 138 * </pre> 139 * 140 * <code>.google.privacy.dlp.v2.Likelihood min_likelihood = 2;</code> 141 * 142 * @return The minLikelihood. 143 */ getMinLikelihood()144 com.google.privacy.dlp.v2.Likelihood getMinLikelihood(); 145 146 /** 147 * 148 * 149 * <pre> 150 * Configuration to control the number of findings returned. 151 * This is not used for data profiling. 152 * When redacting sensitive data from images, finding limits don't apply. They 153 * can cause unexpected or inconsistent results, where only some data is 154 * redacted. Don't include finding limits in 155 * [RedactImage][google.privacy.dlp.v2.DlpService.RedactImage] 156 * requests. Otherwise, Cloud DLP returns an error. 157 * </pre> 158 * 159 * <code>.google.privacy.dlp.v2.InspectConfig.FindingLimits limits = 3;</code> 160 * 161 * @return Whether the limits field is set. 162 */ hasLimits()163 boolean hasLimits(); 164 /** 165 * 166 * 167 * <pre> 168 * Configuration to control the number of findings returned. 169 * This is not used for data profiling. 170 * When redacting sensitive data from images, finding limits don't apply. They 171 * can cause unexpected or inconsistent results, where only some data is 172 * redacted. Don't include finding limits in 173 * [RedactImage][google.privacy.dlp.v2.DlpService.RedactImage] 174 * requests. Otherwise, Cloud DLP returns an error. 175 * </pre> 176 * 177 * <code>.google.privacy.dlp.v2.InspectConfig.FindingLimits limits = 3;</code> 178 * 179 * @return The limits. 180 */ getLimits()181 com.google.privacy.dlp.v2.InspectConfig.FindingLimits getLimits(); 182 /** 183 * 184 * 185 * <pre> 186 * Configuration to control the number of findings returned. 187 * This is not used for data profiling. 188 * When redacting sensitive data from images, finding limits don't apply. They 189 * can cause unexpected or inconsistent results, where only some data is 190 * redacted. Don't include finding limits in 191 * [RedactImage][google.privacy.dlp.v2.DlpService.RedactImage] 192 * requests. Otherwise, Cloud DLP returns an error. 193 * </pre> 194 * 195 * <code>.google.privacy.dlp.v2.InspectConfig.FindingLimits limits = 3;</code> 196 */ getLimitsOrBuilder()197 com.google.privacy.dlp.v2.InspectConfig.FindingLimitsOrBuilder getLimitsOrBuilder(); 198 199 /** 200 * 201 * 202 * <pre> 203 * When true, a contextual quote from the data that triggered a finding is 204 * included in the response; see [Finding.quote][google.privacy.dlp.v2.Finding.quote]. 205 * This is not used for data profiling. 206 * </pre> 207 * 208 * <code>bool include_quote = 4;</code> 209 * 210 * @return The includeQuote. 211 */ getIncludeQuote()212 boolean getIncludeQuote(); 213 214 /** 215 * 216 * 217 * <pre> 218 * When true, excludes type information of the findings. 219 * This is not used for data profiling. 220 * </pre> 221 * 222 * <code>bool exclude_info_types = 5;</code> 223 * 224 * @return The excludeInfoTypes. 225 */ getExcludeInfoTypes()226 boolean getExcludeInfoTypes(); 227 228 /** 229 * 230 * 231 * <pre> 232 * CustomInfoTypes provided by the user. See 233 * https://cloud.google.com/dlp/docs/creating-custom-infotypes to learn more. 234 * </pre> 235 * 236 * <code>repeated .google.privacy.dlp.v2.CustomInfoType custom_info_types = 6;</code> 237 */ getCustomInfoTypesList()238 java.util.List<com.google.privacy.dlp.v2.CustomInfoType> getCustomInfoTypesList(); 239 /** 240 * 241 * 242 * <pre> 243 * CustomInfoTypes provided by the user. See 244 * https://cloud.google.com/dlp/docs/creating-custom-infotypes to learn more. 245 * </pre> 246 * 247 * <code>repeated .google.privacy.dlp.v2.CustomInfoType custom_info_types = 6;</code> 248 */ getCustomInfoTypes(int index)249 com.google.privacy.dlp.v2.CustomInfoType getCustomInfoTypes(int index); 250 /** 251 * 252 * 253 * <pre> 254 * CustomInfoTypes provided by the user. See 255 * https://cloud.google.com/dlp/docs/creating-custom-infotypes to learn more. 256 * </pre> 257 * 258 * <code>repeated .google.privacy.dlp.v2.CustomInfoType custom_info_types = 6;</code> 259 */ getCustomInfoTypesCount()260 int getCustomInfoTypesCount(); 261 /** 262 * 263 * 264 * <pre> 265 * CustomInfoTypes provided by the user. See 266 * https://cloud.google.com/dlp/docs/creating-custom-infotypes to learn more. 267 * </pre> 268 * 269 * <code>repeated .google.privacy.dlp.v2.CustomInfoType custom_info_types = 6;</code> 270 */ 271 java.util.List<? extends com.google.privacy.dlp.v2.CustomInfoTypeOrBuilder> getCustomInfoTypesOrBuilderList()272 getCustomInfoTypesOrBuilderList(); 273 /** 274 * 275 * 276 * <pre> 277 * CustomInfoTypes provided by the user. See 278 * https://cloud.google.com/dlp/docs/creating-custom-infotypes to learn more. 279 * </pre> 280 * 281 * <code>repeated .google.privacy.dlp.v2.CustomInfoType custom_info_types = 6;</code> 282 */ getCustomInfoTypesOrBuilder(int index)283 com.google.privacy.dlp.v2.CustomInfoTypeOrBuilder getCustomInfoTypesOrBuilder(int index); 284 285 /** 286 * 287 * 288 * <pre> 289 * Deprecated and unused. 290 * </pre> 291 * 292 * <code>repeated .google.privacy.dlp.v2.ContentOption content_options = 8;</code> 293 * 294 * @return A list containing the contentOptions. 295 */ getContentOptionsList()296 java.util.List<com.google.privacy.dlp.v2.ContentOption> getContentOptionsList(); 297 /** 298 * 299 * 300 * <pre> 301 * Deprecated and unused. 302 * </pre> 303 * 304 * <code>repeated .google.privacy.dlp.v2.ContentOption content_options = 8;</code> 305 * 306 * @return The count of contentOptions. 307 */ getContentOptionsCount()308 int getContentOptionsCount(); 309 /** 310 * 311 * 312 * <pre> 313 * Deprecated and unused. 314 * </pre> 315 * 316 * <code>repeated .google.privacy.dlp.v2.ContentOption content_options = 8;</code> 317 * 318 * @param index The index of the element to return. 319 * @return The contentOptions at the given index. 320 */ getContentOptions(int index)321 com.google.privacy.dlp.v2.ContentOption getContentOptions(int index); 322 /** 323 * 324 * 325 * <pre> 326 * Deprecated and unused. 327 * </pre> 328 * 329 * <code>repeated .google.privacy.dlp.v2.ContentOption content_options = 8;</code> 330 * 331 * @return A list containing the enum numeric values on the wire for contentOptions. 332 */ getContentOptionsValueList()333 java.util.List<java.lang.Integer> getContentOptionsValueList(); 334 /** 335 * 336 * 337 * <pre> 338 * Deprecated and unused. 339 * </pre> 340 * 341 * <code>repeated .google.privacy.dlp.v2.ContentOption content_options = 8;</code> 342 * 343 * @param index The index of the value to return. 344 * @return The enum numeric value on the wire of contentOptions at the given index. 345 */ getContentOptionsValue(int index)346 int getContentOptionsValue(int index); 347 348 /** 349 * 350 * 351 * <pre> 352 * Set of rules to apply to the findings for this InspectConfig. 353 * Exclusion rules, contained in the set are executed in the end, other 354 * rules are executed in the order they are specified for each info type. 355 * </pre> 356 * 357 * <code>repeated .google.privacy.dlp.v2.InspectionRuleSet rule_set = 10;</code> 358 */ getRuleSetList()359 java.util.List<com.google.privacy.dlp.v2.InspectionRuleSet> getRuleSetList(); 360 /** 361 * 362 * 363 * <pre> 364 * Set of rules to apply to the findings for this InspectConfig. 365 * Exclusion rules, contained in the set are executed in the end, other 366 * rules are executed in the order they are specified for each info type. 367 * </pre> 368 * 369 * <code>repeated .google.privacy.dlp.v2.InspectionRuleSet rule_set = 10;</code> 370 */ getRuleSet(int index)371 com.google.privacy.dlp.v2.InspectionRuleSet getRuleSet(int index); 372 /** 373 * 374 * 375 * <pre> 376 * Set of rules to apply to the findings for this InspectConfig. 377 * Exclusion rules, contained in the set are executed in the end, other 378 * rules are executed in the order they are specified for each info type. 379 * </pre> 380 * 381 * <code>repeated .google.privacy.dlp.v2.InspectionRuleSet rule_set = 10;</code> 382 */ getRuleSetCount()383 int getRuleSetCount(); 384 /** 385 * 386 * 387 * <pre> 388 * Set of rules to apply to the findings for this InspectConfig. 389 * Exclusion rules, contained in the set are executed in the end, other 390 * rules are executed in the order they are specified for each info type. 391 * </pre> 392 * 393 * <code>repeated .google.privacy.dlp.v2.InspectionRuleSet rule_set = 10;</code> 394 */ 395 java.util.List<? extends com.google.privacy.dlp.v2.InspectionRuleSetOrBuilder> getRuleSetOrBuilderList()396 getRuleSetOrBuilderList(); 397 /** 398 * 399 * 400 * <pre> 401 * Set of rules to apply to the findings for this InspectConfig. 402 * Exclusion rules, contained in the set are executed in the end, other 403 * rules are executed in the order they are specified for each info type. 404 * </pre> 405 * 406 * <code>repeated .google.privacy.dlp.v2.InspectionRuleSet rule_set = 10;</code> 407 */ getRuleSetOrBuilder(int index)408 com.google.privacy.dlp.v2.InspectionRuleSetOrBuilder getRuleSetOrBuilder(int index); 409 } 410