Class Finding (3.57.0) 

public final class Finding extends GeneratedMessageV3 implements FindingOrBuilder

Represents a piece of potentially sensitive content.

Protobuf type google.privacy.dlp.v2.Finding

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Finding

Implements

FindingOrBuilder

Static Fields

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

FINDING_ID_FIELD_NUMBER

public static final int FINDING_ID_FIELD_NUMBER
Field Value
Type Description
int

INFO_TYPE_FIELD_NUMBER

public static final int INFO_TYPE_FIELD_NUMBER
Field Value
Type Description
int

JOB_CREATE_TIME_FIELD_NUMBER

public static final int JOB_CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

JOB_NAME_FIELD_NUMBER

public static final int JOB_NAME_FIELD_NUMBER
Field Value
Type Description
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
Type Description
int

LIKELIHOOD_FIELD_NUMBER

public static final int LIKELIHOOD_FIELD_NUMBER
Field Value
Type Description
int

LOCATION_FIELD_NUMBER

public static final int LOCATION_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

QUOTE_FIELD_NUMBER

public static final int QUOTE_FIELD_NUMBER
Field Value
Type Description
int

QUOTE_INFO_FIELD_NUMBER

public static final int QUOTE_INFO_FIELD_NUMBER
Field Value
Type Description
int

RESOURCE_NAME_FIELD_NUMBER

public static final int RESOURCE_NAME_FIELD_NUMBER
Field Value
Type Description
int

TRIGGER_NAME_FIELD_NUMBER

public static final int TRIGGER_NAME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Finding getDefaultInstance()
Returns
Type Description
Finding

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Finding.Builder newBuilder()
Returns
Type Description
Finding.Builder

newBuilder(Finding prototype)

public static Finding.Builder newBuilder(Finding prototype)
Parameter
Name Description
prototype Finding
Returns
Type Description
Finding.Builder

parseDelimitedFrom(InputStream input)

public static Finding parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Finding
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Finding parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Finding
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Finding parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Finding
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Finding parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Finding
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Finding parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Finding
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Finding parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Finding
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Finding parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Finding
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Finding parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Finding
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Finding parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Finding
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Finding parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Finding
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Finding parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Finding
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Finding parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Finding
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Finding> parser()
Returns
Type Description
Parser<Finding>

Methods

containsLabels(String key)

public 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

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getCreateTime()

public Timestamp getCreateTime()

Timestamp when finding was detected.

.google.protobuf.Timestamp create_time = 6;

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Timestamp when finding was detected.

.google.protobuf.Timestamp create_time = 6;

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public Finding getDefaultInstanceForType()
Returns
Type Description
Finding

getFindingId()

public String getFindingId()

The unique finding id.

string finding_id = 15;

Returns
Type Description
String

The findingId.

getFindingIdBytes()

public ByteString getFindingIdBytes()

The unique finding id.

string finding_id = 15;

Returns
Type Description
ByteString

The bytes for findingId.

getInfoType()

public 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 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 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 TimestampOrBuilder getJobCreateTimeOrBuilder()

Time the job started that produced this finding.

.google.protobuf.Timestamp job_create_time = 11;

Returns
Type Description
TimestampOrBuilder

getJobName()

public String getJobName()

The job that stored the finding.

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

Returns
Type Description
String

The jobName.

getJobNameBytes()

public 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 Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public 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 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 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 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 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 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 Location getLocation()

Where the content was found.

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

Returns
Type Description
Location

The location.

getLocationOrBuilder()

public LocationOrBuilder getLocationOrBuilder()

Where the content was found.

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

Returns
Type Description
LocationOrBuilder

getName()

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

getParserForType()

public Parser<Finding> getParserForType()
Returns
Type Description
Parser<Finding>
Overrides

getQuote()

public 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 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 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 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 String getResourceName()

The job that stored the finding.

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

Returns
Type Description
String

The resourceName.

getResourceNameBytes()

public ByteString getResourceNameBytes()

The job that stored the finding.

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

Returns
Type Description
ByteString

The bytes for resourceName.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getTriggerName()

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

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Finding.Builder newBuilderForType()
Returns
Type Description
Finding.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Finding.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Finding.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Finding.Builder toBuilder()
Returns
Type Description
Finding.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException