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 FindingOrBuilder 22 extends 23 // @@protoc_insertion_point(interface_extends:google.privacy.dlp.v2.Finding) 24 com.google.protobuf.MessageOrBuilder { 25 26 /** 27 * 28 * 29 * <pre> 30 * Resource name in format 31 * projects/{project}/locations/{location}/findings/{finding} Populated only 32 * when viewing persisted findings. 33 * </pre> 34 * 35 * <code>string name = 14;</code> 36 * 37 * @return The name. 38 */ getName()39 java.lang.String getName(); 40 /** 41 * 42 * 43 * <pre> 44 * Resource name in format 45 * projects/{project}/locations/{location}/findings/{finding} Populated only 46 * when viewing persisted findings. 47 * </pre> 48 * 49 * <code>string name = 14;</code> 50 * 51 * @return The bytes for name. 52 */ getNameBytes()53 com.google.protobuf.ByteString getNameBytes(); 54 55 /** 56 * 57 * 58 * <pre> 59 * The content that was found. Even if the content is not textual, it 60 * may be converted to a textual representation here. 61 * Provided if `include_quote` is true and the finding is 62 * less than or equal to 4096 bytes long. If the finding exceeds 4096 bytes 63 * in length, the quote may be omitted. 64 * </pre> 65 * 66 * <code>string quote = 1;</code> 67 * 68 * @return The quote. 69 */ getQuote()70 java.lang.String getQuote(); 71 /** 72 * 73 * 74 * <pre> 75 * The content that was found. Even if the content is not textual, it 76 * may be converted to a textual representation here. 77 * Provided if `include_quote` is true and the finding is 78 * less than or equal to 4096 bytes long. If the finding exceeds 4096 bytes 79 * in length, the quote may be omitted. 80 * </pre> 81 * 82 * <code>string quote = 1;</code> 83 * 84 * @return The bytes for quote. 85 */ getQuoteBytes()86 com.google.protobuf.ByteString getQuoteBytes(); 87 88 /** 89 * 90 * 91 * <pre> 92 * The type of content that might have been found. 93 * Provided if `excluded_types` is false. 94 * </pre> 95 * 96 * <code>.google.privacy.dlp.v2.InfoType info_type = 2;</code> 97 * 98 * @return Whether the infoType field is set. 99 */ hasInfoType()100 boolean hasInfoType(); 101 /** 102 * 103 * 104 * <pre> 105 * The type of content that might have been found. 106 * Provided if `excluded_types` is false. 107 * </pre> 108 * 109 * <code>.google.privacy.dlp.v2.InfoType info_type = 2;</code> 110 * 111 * @return The infoType. 112 */ getInfoType()113 com.google.privacy.dlp.v2.InfoType getInfoType(); 114 /** 115 * 116 * 117 * <pre> 118 * The type of content that might have been found. 119 * Provided if `excluded_types` is false. 120 * </pre> 121 * 122 * <code>.google.privacy.dlp.v2.InfoType info_type = 2;</code> 123 */ getInfoTypeOrBuilder()124 com.google.privacy.dlp.v2.InfoTypeOrBuilder getInfoTypeOrBuilder(); 125 126 /** 127 * 128 * 129 * <pre> 130 * Confidence of how likely it is that the `info_type` is correct. 131 * </pre> 132 * 133 * <code>.google.privacy.dlp.v2.Likelihood likelihood = 3;</code> 134 * 135 * @return The enum numeric value on the wire for likelihood. 136 */ getLikelihoodValue()137 int getLikelihoodValue(); 138 /** 139 * 140 * 141 * <pre> 142 * Confidence of how likely it is that the `info_type` is correct. 143 * </pre> 144 * 145 * <code>.google.privacy.dlp.v2.Likelihood likelihood = 3;</code> 146 * 147 * @return The likelihood. 148 */ getLikelihood()149 com.google.privacy.dlp.v2.Likelihood getLikelihood(); 150 151 /** 152 * 153 * 154 * <pre> 155 * Where the content was found. 156 * </pre> 157 * 158 * <code>.google.privacy.dlp.v2.Location location = 4;</code> 159 * 160 * @return Whether the location field is set. 161 */ hasLocation()162 boolean hasLocation(); 163 /** 164 * 165 * 166 * <pre> 167 * Where the content was found. 168 * </pre> 169 * 170 * <code>.google.privacy.dlp.v2.Location location = 4;</code> 171 * 172 * @return The location. 173 */ getLocation()174 com.google.privacy.dlp.v2.Location getLocation(); 175 /** 176 * 177 * 178 * <pre> 179 * Where the content was found. 180 * </pre> 181 * 182 * <code>.google.privacy.dlp.v2.Location location = 4;</code> 183 */ getLocationOrBuilder()184 com.google.privacy.dlp.v2.LocationOrBuilder getLocationOrBuilder(); 185 186 /** 187 * 188 * 189 * <pre> 190 * Timestamp when finding was detected. 191 * </pre> 192 * 193 * <code>.google.protobuf.Timestamp create_time = 6;</code> 194 * 195 * @return Whether the createTime field is set. 196 */ hasCreateTime()197 boolean hasCreateTime(); 198 /** 199 * 200 * 201 * <pre> 202 * Timestamp when finding was detected. 203 * </pre> 204 * 205 * <code>.google.protobuf.Timestamp create_time = 6;</code> 206 * 207 * @return The createTime. 208 */ getCreateTime()209 com.google.protobuf.Timestamp getCreateTime(); 210 /** 211 * 212 * 213 * <pre> 214 * Timestamp when finding was detected. 215 * </pre> 216 * 217 * <code>.google.protobuf.Timestamp create_time = 6;</code> 218 */ getCreateTimeOrBuilder()219 com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder(); 220 221 /** 222 * 223 * 224 * <pre> 225 * Contains data parsed from quotes. Only populated if include_quote was set 226 * to true and a supported infoType was requested. Currently supported 227 * infoTypes: DATE, DATE_OF_BIRTH and TIME. 228 * </pre> 229 * 230 * <code>.google.privacy.dlp.v2.QuoteInfo quote_info = 7;</code> 231 * 232 * @return Whether the quoteInfo field is set. 233 */ hasQuoteInfo()234 boolean hasQuoteInfo(); 235 /** 236 * 237 * 238 * <pre> 239 * Contains data parsed from quotes. Only populated if include_quote was set 240 * to true and a supported infoType was requested. Currently supported 241 * infoTypes: DATE, DATE_OF_BIRTH and TIME. 242 * </pre> 243 * 244 * <code>.google.privacy.dlp.v2.QuoteInfo quote_info = 7;</code> 245 * 246 * @return The quoteInfo. 247 */ getQuoteInfo()248 com.google.privacy.dlp.v2.QuoteInfo getQuoteInfo(); 249 /** 250 * 251 * 252 * <pre> 253 * Contains data parsed from quotes. Only populated if include_quote was set 254 * to true and a supported infoType was requested. Currently supported 255 * infoTypes: DATE, DATE_OF_BIRTH and TIME. 256 * </pre> 257 * 258 * <code>.google.privacy.dlp.v2.QuoteInfo quote_info = 7;</code> 259 */ getQuoteInfoOrBuilder()260 com.google.privacy.dlp.v2.QuoteInfoOrBuilder getQuoteInfoOrBuilder(); 261 262 /** 263 * 264 * 265 * <pre> 266 * The job that stored the finding. 267 * </pre> 268 * 269 * <code>string resource_name = 8 [(.google.api.resource_reference) = { ... }</code> 270 * 271 * @return The resourceName. 272 */ getResourceName()273 java.lang.String getResourceName(); 274 /** 275 * 276 * 277 * <pre> 278 * The job that stored the finding. 279 * </pre> 280 * 281 * <code>string resource_name = 8 [(.google.api.resource_reference) = { ... }</code> 282 * 283 * @return The bytes for resourceName. 284 */ getResourceNameBytes()285 com.google.protobuf.ByteString getResourceNameBytes(); 286 287 /** 288 * 289 * 290 * <pre> 291 * Job trigger name, if applicable, for this finding. 292 * </pre> 293 * 294 * <code>string trigger_name = 9 [(.google.api.resource_reference) = { ... }</code> 295 * 296 * @return The triggerName. 297 */ getTriggerName()298 java.lang.String getTriggerName(); 299 /** 300 * 301 * 302 * <pre> 303 * Job trigger name, if applicable, for this finding. 304 * </pre> 305 * 306 * <code>string trigger_name = 9 [(.google.api.resource_reference) = { ... }</code> 307 * 308 * @return The bytes for triggerName. 309 */ getTriggerNameBytes()310 com.google.protobuf.ByteString getTriggerNameBytes(); 311 312 /** 313 * 314 * 315 * <pre> 316 * The labels associated with this `Finding`. 317 * Label keys must be between 1 and 63 characters long and must conform 318 * to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`. 319 * Label values must be between 0 and 63 characters long and must conform 320 * to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`. 321 * No more than 10 labels can be associated with a given finding. 322 * Examples: 323 * * `"environment" : "production"` 324 * * `"pipeline" : "etl"` 325 * </pre> 326 * 327 * <code>map<string, string> labels = 10;</code> 328 */ getLabelsCount()329 int getLabelsCount(); 330 /** 331 * 332 * 333 * <pre> 334 * The labels associated with this `Finding`. 335 * Label keys must be between 1 and 63 characters long and must conform 336 * to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`. 337 * Label values must be between 0 and 63 characters long and must conform 338 * to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`. 339 * No more than 10 labels can be associated with a given finding. 340 * Examples: 341 * * `"environment" : "production"` 342 * * `"pipeline" : "etl"` 343 * </pre> 344 * 345 * <code>map<string, string> labels = 10;</code> 346 */ containsLabels(java.lang.String key)347 boolean containsLabels(java.lang.String key); 348 /** Use {@link #getLabelsMap()} instead. */ 349 @java.lang.Deprecated getLabels()350 java.util.Map<java.lang.String, java.lang.String> getLabels(); 351 /** 352 * 353 * 354 * <pre> 355 * The labels associated with this `Finding`. 356 * Label keys must be between 1 and 63 characters long and must conform 357 * to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`. 358 * Label values must be between 0 and 63 characters long and must conform 359 * to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`. 360 * No more than 10 labels can be associated with a given finding. 361 * Examples: 362 * * `"environment" : "production"` 363 * * `"pipeline" : "etl"` 364 * </pre> 365 * 366 * <code>map<string, string> labels = 10;</code> 367 */ getLabelsMap()368 java.util.Map<java.lang.String, java.lang.String> getLabelsMap(); 369 /** 370 * 371 * 372 * <pre> 373 * The labels associated with this `Finding`. 374 * Label keys must be between 1 and 63 characters long and must conform 375 * to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`. 376 * Label values must be between 0 and 63 characters long and must conform 377 * to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`. 378 * No more than 10 labels can be associated with a given finding. 379 * Examples: 380 * * `"environment" : "production"` 381 * * `"pipeline" : "etl"` 382 * </pre> 383 * 384 * <code>map<string, string> labels = 10;</code> 385 */ 386 /* nullable */ getLabelsOrDefault( java.lang.String key, java.lang.String defaultValue)387 java.lang.String getLabelsOrDefault( 388 java.lang.String key, 389 /* nullable */ 390 java.lang.String defaultValue); 391 /** 392 * 393 * 394 * <pre> 395 * The labels associated with this `Finding`. 396 * Label keys must be between 1 and 63 characters long and must conform 397 * to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`. 398 * Label values must be between 0 and 63 characters long and must conform 399 * to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`. 400 * No more than 10 labels can be associated with a given finding. 401 * Examples: 402 * * `"environment" : "production"` 403 * * `"pipeline" : "etl"` 404 * </pre> 405 * 406 * <code>map<string, string> labels = 10;</code> 407 */ getLabelsOrThrow(java.lang.String key)408 java.lang.String getLabelsOrThrow(java.lang.String key); 409 410 /** 411 * 412 * 413 * <pre> 414 * Time the job started that produced this finding. 415 * </pre> 416 * 417 * <code>.google.protobuf.Timestamp job_create_time = 11;</code> 418 * 419 * @return Whether the jobCreateTime field is set. 420 */ hasJobCreateTime()421 boolean hasJobCreateTime(); 422 /** 423 * 424 * 425 * <pre> 426 * Time the job started that produced this finding. 427 * </pre> 428 * 429 * <code>.google.protobuf.Timestamp job_create_time = 11;</code> 430 * 431 * @return The jobCreateTime. 432 */ getJobCreateTime()433 com.google.protobuf.Timestamp getJobCreateTime(); 434 /** 435 * 436 * 437 * <pre> 438 * Time the job started that produced this finding. 439 * </pre> 440 * 441 * <code>.google.protobuf.Timestamp job_create_time = 11;</code> 442 */ getJobCreateTimeOrBuilder()443 com.google.protobuf.TimestampOrBuilder getJobCreateTimeOrBuilder(); 444 445 /** 446 * 447 * 448 * <pre> 449 * The job that stored the finding. 450 * </pre> 451 * 452 * <code>string job_name = 13 [(.google.api.resource_reference) = { ... }</code> 453 * 454 * @return The jobName. 455 */ getJobName()456 java.lang.String getJobName(); 457 /** 458 * 459 * 460 * <pre> 461 * The job that stored the finding. 462 * </pre> 463 * 464 * <code>string job_name = 13 [(.google.api.resource_reference) = { ... }</code> 465 * 466 * @return The bytes for jobName. 467 */ getJobNameBytes()468 com.google.protobuf.ByteString getJobNameBytes(); 469 470 /** 471 * 472 * 473 * <pre> 474 * The unique finding id. 475 * </pre> 476 * 477 * <code>string finding_id = 15;</code> 478 * 479 * @return The findingId. 480 */ getFindingId()481 java.lang.String getFindingId(); 482 /** 483 * 484 * 485 * <pre> 486 * The unique finding id. 487 * </pre> 488 * 489 * <code>string finding_id = 15;</code> 490 * 491 * @return The bytes for findingId. 492 */ getFindingIdBytes()493 com.google.protobuf.ByteString getFindingIdBytes(); 494 } 495