Data Loss Prevention V2 Client - Class Finding (1.10.2)

Reference documentation and code samples for the Data Loss Prevention V2 Client class Finding.

Represents a piece of potentially sensitive content.

Generated from protobuf message google.privacy.dlp.v2.Finding

Namespace

Google \ Cloud \ Dlp \ V2

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ name string

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

↳ quote string

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.

↳ info_type Google\Cloud\Dlp\V2\InfoType

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

↳ likelihood int

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

↳ location Google\Cloud\Dlp\V2\Location

Where the content was found.

↳ create_time Google\Protobuf\Timestamp

Timestamp when finding was detected.

↳ quote_info Google\Cloud\Dlp\V2\QuoteInfo

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.

↳ resource_name string

The job that stored the finding.

↳ trigger_name string

Job trigger name, if applicable, for this finding.

↳ labels array|Google\Protobuf\Internal\MapField

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"

↳ job_create_time Google\Protobuf\Timestamp

Time the job started that produced this finding.

↳ job_name string

The job that stored the finding.

↳ finding_id string

The unique finding id.

getName

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

Returns
TypeDescription
string

setName

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

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.

Returns
TypeDescription
string

setQuote

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.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getInfoType

The type of content that might have been found.

Provided if excluded_types is false.

Returns
TypeDescription
Google\Cloud\Dlp\V2\InfoType|null

hasInfoType

clearInfoType

setInfoType

The type of content that might have been found.

Provided if excluded_types is false.

Parameter
NameDescription
var Google\Cloud\Dlp\V2\InfoType
Returns
TypeDescription
$this

getLikelihood

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

Returns
TypeDescription
int

setLikelihood

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

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getLocation

Where the content was found.

Returns
TypeDescription
Google\Cloud\Dlp\V2\Location|null

hasLocation

clearLocation

setLocation

Where the content was found.

Parameter
NameDescription
var Google\Cloud\Dlp\V2\Location
Returns
TypeDescription
$this

getCreateTime

Timestamp when finding was detected.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Timestamp when finding was detected.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

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.

Returns
TypeDescription
Google\Cloud\Dlp\V2\QuoteInfo|null

hasQuoteInfo

clearQuoteInfo

setQuoteInfo

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.

Parameter
NameDescription
var Google\Cloud\Dlp\V2\QuoteInfo
Returns
TypeDescription
$this

getResourceName

The job that stored the finding.

Returns
TypeDescription
string

setResourceName

The job that stored the finding.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getTriggerName

Job trigger name, if applicable, for this finding.

Returns
TypeDescription
string

setTriggerName

Job trigger name, if applicable, for this finding.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

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"
Returns
TypeDescription
Google\Protobuf\Internal\MapField

setLabels

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"
Parameter
NameDescription
var array|Google\Protobuf\Internal\MapField
Returns
TypeDescription
$this

getJobCreateTime

Time the job started that produced this finding.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasJobCreateTime

clearJobCreateTime

setJobCreateTime

Time the job started that produced this finding.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getJobName

The job that stored the finding.

Returns
TypeDescription
string

setJobName

The job that stored the finding.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getFindingId

The unique finding id.

Returns
TypeDescription
string

setFindingId

The unique finding id.

Parameter
NameDescription
var string
Returns
TypeDescription
$this