/*
* Copyright 2020 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/privacy/dlp/v2/dlp.proto
package com.google.privacy.dlp.v2;
public interface FindingOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.privacy.dlp.v2.Finding)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* Resource name in format
* projects/{project}/locations/{location}/findings/{finding} Populated only
* when viewing persisted findings.
*
*
* string name = 14;
*
* @return The name.
*/
java.lang.String getName();
/**
*
*
*
* Resource name in format
* projects/{project}/locations/{location}/findings/{finding} Populated only
* when viewing persisted findings.
*
*
* string name = 14;
*
* @return The bytes for name.
*/
com.google.protobuf.ByteString getNameBytes();
/**
*
*
*
* The content that was found. Even if the content is not textual, it
* may be converted to a textual representation here.
* Provided if `include_quote` is true and the finding is
* less than or equal to 4096 bytes long. If the finding exceeds 4096 bytes
* in length, the quote may be omitted.
*
*
* string quote = 1;
*
* @return The quote.
*/
java.lang.String getQuote();
/**
*
*
*
* The content that was found. Even if the content is not textual, it
* may be converted to a textual representation here.
* Provided if `include_quote` is true and the finding is
* less than or equal to 4096 bytes long. If the finding exceeds 4096 bytes
* in length, the quote may be omitted.
*
*
* string quote = 1;
*
* @return The bytes for quote.
*/
com.google.protobuf.ByteString getQuoteBytes();
/**
*
*
*
* The type of content that might have been found.
* Provided if `excluded_types` is false.
*
*
* .google.privacy.dlp.v2.InfoType info_type = 2;
*
* @return Whether the infoType field is set.
*/
boolean hasInfoType();
/**
*
*
*
* The type of content that might have been found.
* Provided if `excluded_types` is false.
*
*
* .google.privacy.dlp.v2.InfoType info_type = 2;
*
* @return The infoType.
*/
com.google.privacy.dlp.v2.InfoType getInfoType();
/**
*
*
*
* The type of content that might have been found.
* Provided if `excluded_types` is false.
*
*
* .google.privacy.dlp.v2.InfoType info_type = 2;
*/
com.google.privacy.dlp.v2.InfoTypeOrBuilder getInfoTypeOrBuilder();
/**
*
*
*
* Confidence of how likely it is that the `info_type` is correct.
*
*
* .google.privacy.dlp.v2.Likelihood likelihood = 3;
*
* @return The enum numeric value on the wire for likelihood.
*/
int getLikelihoodValue();
/**
*
*
*
* Confidence of how likely it is that the `info_type` is correct.
*
*
* .google.privacy.dlp.v2.Likelihood likelihood = 3;
*
* @return The likelihood.
*/
com.google.privacy.dlp.v2.Likelihood getLikelihood();
/**
*
*
*
* Where the content was found.
*
*
* .google.privacy.dlp.v2.Location location = 4;
*
* @return Whether the location field is set.
*/
boolean hasLocation();
/**
*
*
*
* Where the content was found.
*
*
* .google.privacy.dlp.v2.Location location = 4;
*
* @return The location.
*/
com.google.privacy.dlp.v2.Location getLocation();
/**
*
*
*
* Where the content was found.
*
*
* .google.privacy.dlp.v2.Location location = 4;
*/
com.google.privacy.dlp.v2.LocationOrBuilder getLocationOrBuilder();
/**
*
*
*
* Timestamp when finding was detected.
*
*
* .google.protobuf.Timestamp create_time = 6;
*
* @return Whether the createTime field is set.
*/
boolean hasCreateTime();
/**
*
*
*
* Timestamp when finding was detected.
*
*
* .google.protobuf.Timestamp create_time = 6;
*
* @return The createTime.
*/
com.google.protobuf.Timestamp getCreateTime();
/**
*
*
*
* Timestamp when finding was detected.
*
*
* .google.protobuf.Timestamp create_time = 6;
*/
com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder();
/**
*
*
*
* Contains data parsed from quotes. Only populated if include_quote was set
* to true and a supported infoType was requested. Currently supported
* infoTypes: DATE, DATE_OF_BIRTH and TIME.
*
*
* .google.privacy.dlp.v2.QuoteInfo quote_info = 7;
*
* @return Whether the quoteInfo field is set.
*/
boolean hasQuoteInfo();
/**
*
*
*
* Contains data parsed from quotes. Only populated if include_quote was set
* to true and a supported infoType was requested. Currently supported
* infoTypes: DATE, DATE_OF_BIRTH and TIME.
*
*
* .google.privacy.dlp.v2.QuoteInfo quote_info = 7;
*
* @return The quoteInfo.
*/
com.google.privacy.dlp.v2.QuoteInfo getQuoteInfo();
/**
*
*
*
* Contains data parsed from quotes. Only populated if include_quote was set
* to true and a supported infoType was requested. Currently supported
* infoTypes: DATE, DATE_OF_BIRTH and TIME.
*
*
* .google.privacy.dlp.v2.QuoteInfo quote_info = 7;
*/
com.google.privacy.dlp.v2.QuoteInfoOrBuilder getQuoteInfoOrBuilder();
/**
*
*
*
* The job that stored the finding.
*
*
* string resource_name = 8 [(.google.api.resource_reference) = { ... }
*
* @return The resourceName.
*/
java.lang.String getResourceName();
/**
*
*
*
* The job that stored the finding.
*
*
* string resource_name = 8 [(.google.api.resource_reference) = { ... }
*
* @return The bytes for resourceName.
*/
com.google.protobuf.ByteString getResourceNameBytes();
/**
*
*
*
* Job trigger name, if applicable, for this finding.
*
*
* string trigger_name = 9 [(.google.api.resource_reference) = { ... }
*
* @return The triggerName.
*/
java.lang.String getTriggerName();
/**
*
*
*
* Job trigger name, if applicable, for this finding.
*
*
* string trigger_name = 9 [(.google.api.resource_reference) = { ... }
*
* @return The bytes for triggerName.
*/
com.google.protobuf.ByteString getTriggerNameBytes();
/**
*
*
*
* The labels associated with this `Finding`.
* Label keys must be between 1 and 63 characters long and must conform
* to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`.
* Label values must be between 0 and 63 characters long and must conform
* to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`.
* No more than 10 labels can be associated with a given finding.
* Examples:
* * `"environment" : "production"`
* * `"pipeline" : "etl"`
*
*
* map<string, string> labels = 10;
*/
int getLabelsCount();
/**
*
*
*
* The labels associated with this `Finding`.
* Label keys must be between 1 and 63 characters long and must conform
* to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`.
* Label values must be between 0 and 63 characters long and must conform
* to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`.
* No more than 10 labels can be associated with a given finding.
* Examples:
* * `"environment" : "production"`
* * `"pipeline" : "etl"`
*
*
* map<string, string> labels = 10;
*/
boolean containsLabels(java.lang.String key);
/** Use {@link #getLabelsMap()} instead. */
@java.lang.Deprecated
java.util.Map getLabels();
/**
*
*
*
* The labels associated with this `Finding`.
* Label keys must be between 1 and 63 characters long and must conform
* to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`.
* Label values must be between 0 and 63 characters long and must conform
* to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`.
* No more than 10 labels can be associated with a given finding.
* Examples:
* * `"environment" : "production"`
* * `"pipeline" : "etl"`
*
*
* map<string, string> labels = 10;
*/
java.util.Map getLabelsMap();
/**
*
*
*
* The labels associated with this `Finding`.
* Label keys must be between 1 and 63 characters long and must conform
* to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`.
* Label values must be between 0 and 63 characters long and must conform
* to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`.
* No more than 10 labels can be associated with a given finding.
* Examples:
* * `"environment" : "production"`
* * `"pipeline" : "etl"`
*
*
* map<string, string> labels = 10;
*/
/* nullable */
java.lang.String getLabelsOrDefault(
java.lang.String key,
/* nullable */
java.lang.String defaultValue);
/**
*
*
*
* The labels associated with this `Finding`.
* Label keys must be between 1 and 63 characters long and must conform
* to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`.
* Label values must be between 0 and 63 characters long and must conform
* to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`.
* No more than 10 labels can be associated with a given finding.
* Examples:
* * `"environment" : "production"`
* * `"pipeline" : "etl"`
*
*
* map<string, string> labels = 10;
*/
java.lang.String getLabelsOrThrow(java.lang.String key);
/**
*
*
*
* Time the job started that produced this finding.
*
*
* .google.protobuf.Timestamp job_create_time = 11;
*
* @return Whether the jobCreateTime field is set.
*/
boolean hasJobCreateTime();
/**
*
*
*
* Time the job started that produced this finding.
*
*
* .google.protobuf.Timestamp job_create_time = 11;
*
* @return The jobCreateTime.
*/
com.google.protobuf.Timestamp getJobCreateTime();
/**
*
*
*
* Time the job started that produced this finding.
*
*
* .google.protobuf.Timestamp job_create_time = 11;
*/
com.google.protobuf.TimestampOrBuilder getJobCreateTimeOrBuilder();
/**
*
*
*
* The job that stored the finding.
*
*
* string job_name = 13 [(.google.api.resource_reference) = { ... }
*
* @return The jobName.
*/
java.lang.String getJobName();
/**
*
*
*
* The job that stored the finding.
*
*
* string job_name = 13 [(.google.api.resource_reference) = { ... }
*
* @return The bytes for jobName.
*/
com.google.protobuf.ByteString getJobNameBytes();
/**
*
*
*
* The unique finding id.
*
*
* string finding_id = 15;
*
* @return The findingId.
*/
java.lang.String getFindingId();
/**
*
*
*
* The unique finding id.
*
*
* string finding_id = 15;
*
* @return The bytes for findingId.
*/
com.google.protobuf.ByteString getFindingIdBytes();
}