Interface FindingOrBuilder (3.57.0)

public interface FindingOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsLabels(String key)

public abstract boolean containsLabels(String key)

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?.

Label values must be between 0 and 63 characters long and must conform to the regular expression (a-z?)?.

No more than 10 labels can be associated with a given finding.

Examples:

  • "environment" : "production"
  • "pipeline" : "etl"

map<string, string> labels = 10;

Parameter
Name Description
key String
Returns
Type Description
boolean

getCreateTime()

public abstract Timestamp getCreateTime()

Timestamp when finding was detected.

.google.protobuf.Timestamp create_time = 6;

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public abstract TimestampOrBuilder getCreateTimeOrBuilder()

Timestamp when finding was detected.

.google.protobuf.Timestamp create_time = 6;

Returns
Type Description
TimestampOrBuilder

getFindingId()

public abstract String getFindingId()

The unique finding id.

string finding_id = 15;

Returns
Type Description
String

The findingId.

getFindingIdBytes()

public abstract ByteString getFindingIdBytes()

The unique finding id.

string finding_id = 15;

Returns
Type Description
ByteString

The bytes for findingId.

getInfoType()

public abstract 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;

Returns
Type Description
InfoType

The infoType.

getInfoTypeOrBuilder()

public abstract InfoTypeOrBuilder getInfoTypeOrBuilder()

The type of content that might have been found. Provided if excluded_types is false.

.google.privacy.dlp.v2.InfoType info_type = 2;

Returns
Type Description
InfoTypeOrBuilder

getJobCreateTime()

public abstract Timestamp getJobCreateTime()

Time the job started that produced this finding.

.google.protobuf.Timestamp job_create_time = 11;

Returns
Type Description
Timestamp

The jobCreateTime.

getJobCreateTimeOrBuilder()

public abstract TimestampOrBuilder getJobCreateTimeOrBuilder()

Time the job started that produced this finding.

.google.protobuf.Timestamp job_create_time = 11;

Returns
Type Description
TimestampOrBuilder

getJobName()

public abstract String getJobName()

The job that stored the finding.

string job_name = 13 [(.google.api.resource_reference) = { ... }

Returns
Type Description
String

The jobName.

getJobNameBytes()

public abstract ByteString getJobNameBytes()

The job that stored the finding.

string job_name = 13 [(.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for jobName.

getLabels() (deprecated)

public abstract Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public abstract 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?.

Label values must be between 0 and 63 characters long and must conform to the regular expression (a-z?)?.

No more than 10 labels can be associated with a given finding.

Examples:

  • "environment" : "production"
  • "pipeline" : "etl"

map<string, string> labels = 10;

Returns
Type Description
int

getLabelsMap()

public abstract Map<String,String> 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?.

Label values must be between 0 and 63 characters long and must conform to the regular expression (a-z?)?.

No more than 10 labels can be associated with a given finding.

Examples:

  • "environment" : "production"
  • "pipeline" : "etl"

map<string, string> labels = 10;

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public abstract String getLabelsOrDefault(String key, 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?.

Label values must be between 0 and 63 characters long and must conform to the regular expression (a-z?)?.

No more than 10 labels can be associated with a given finding.

Examples:

  • "environment" : "production"
  • "pipeline" : "etl"

map<string, string> labels = 10;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

public abstract String getLabelsOrThrow(String key)

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?.

Label values must be between 0 and 63 characters long and must conform to the regular expression (a-z?)?.

No more than 10 labels can be associated with a given finding.

Examples:

  • "environment" : "production"
  • "pipeline" : "etl"

map<string, string> labels = 10;

Parameter
Name Description
key String
Returns
Type Description
String

getLikelihood()

public abstract Likelihood getLikelihood()

Confidence of how likely it is that the info_type is correct.

.google.privacy.dlp.v2.Likelihood likelihood = 3;

Returns
Type Description
Likelihood

The likelihood.

getLikelihoodValue()

public abstract int getLikelihoodValue()

Confidence of how likely it is that the info_type is correct.

.google.privacy.dlp.v2.Likelihood likelihood = 3;

Returns
Type Description
int

The enum numeric value on the wire for likelihood.

getLocation()

public abstract Location getLocation()

Where the content was found.

.google.privacy.dlp.v2.Location location = 4;

Returns
Type Description
Location

The location.

getLocationOrBuilder()

public abstract LocationOrBuilder getLocationOrBuilder()

Where the content was found.

.google.privacy.dlp.v2.Location location = 4;

Returns
Type Description
LocationOrBuilder

getName()

public abstract String getName()

Resource name in format projects/{project}/locations/{location}/findings/{finding} Populated only when viewing persisted findings.

string name = 14;

Returns
Type Description
String

The name.

getNameBytes()

public abstract ByteString getNameBytes()

Resource name in format projects/{project}/locations/{location}/findings/{finding} Populated only when viewing persisted findings.

string name = 14;

Returns
Type Description
ByteString

The bytes for name.

getQuote()

public abstract 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;

Returns
Type Description
String

The quote.

getQuoteBytes()

public abstract ByteString getQuoteBytes()

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;

Returns
Type Description
ByteString

The bytes for quote.

getQuoteInfo()

public abstract 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;

Returns
Type Description
QuoteInfo

The quoteInfo.

getQuoteInfoOrBuilder()

public abstract QuoteInfoOrBuilder getQuoteInfoOrBuilder()

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;

Returns
Type Description
QuoteInfoOrBuilder

getResourceName()

public abstract String getResourceName()

The job that stored the finding.

string resource_name = 8 [(.google.api.resource_reference) = { ... }

Returns
Type Description
String

The resourceName.

getResourceNameBytes()

public abstract ByteString getResourceNameBytes()

The job that stored the finding.

string resource_name = 8 [(.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for resourceName.

getTriggerName()

public abstract String getTriggerName()

Job trigger name, if applicable, for this finding.

string trigger_name = 9 [(.google.api.resource_reference) = { ... }

Returns
Type Description
String

The triggerName.

getTriggerNameBytes()

public abstract ByteString getTriggerNameBytes()

Job trigger name, if applicable, for this finding.

string trigger_name = 9 [(.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for triggerName.

hasCreateTime()

public abstract boolean hasCreateTime()

Timestamp when finding was detected.

.google.protobuf.Timestamp create_time = 6;

Returns
Type Description
boolean

Whether the createTime field is set.

hasInfoType()

public abstract 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;

Returns
Type Description
boolean

Whether the infoType field is set.

hasJobCreateTime()

public abstract boolean hasJobCreateTime()

Time the job started that produced this finding.

.google.protobuf.Timestamp job_create_time = 11;

Returns
Type Description
boolean

Whether the jobCreateTime field is set.

hasLocation()

public abstract boolean hasLocation()

Where the content was found.

.google.privacy.dlp.v2.Location location = 4;

Returns
Type Description
boolean

Whether the location field is set.

hasQuoteInfo()

public abstract 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;

Returns
Type Description
boolean

Whether the quoteInfo field is set.