Data Loss Prevention V2 Client - Class HybridFindingDetails (1.19.0)

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

Populate to associate additional data with each finding.

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

Namespace

Google \ Cloud \ Dlp \ V2

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ container_details Google\Cloud\Dlp\V2\Container

Details about the container where the content being inspected is from.
↳ file_offset int|string

Offset in bytes of the line, from the beginning of the file, where the finding is located. Populate if the item being scanned is only part of a bigger item, such as a shard of a file and you want to track the absolute position of the finding.
↳ row_offset int|string

Offset of the row for tables. Populate if the row(s) being scanned are part of a bigger dataset and you want to keep track of their absolute position.
↳ table_options Google\Cloud\Dlp\V2\TableOptions

If the container is a table, additional information to make findings meaningful such as the columns that are primary keys. If not known ahead of time, can also be set within each inspect hybrid call and the two will be merged. Note that identifying_fields will only be stored to BigQuery, and only if the BigQuery action has been included.
↳ labels array|Google\Protobuf\Internal\MapField

Labels to represent user provided metadata about the data being inspected. If configured by the job, some key values may be required. The labels associated with Finding's produced by hybrid inspection. 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"

getContainerDetails

Details about the container where the content being inspected is from.

Returns
Type Description
Google\Cloud\Dlp\V2\Container|null

hasContainerDetails

clearContainerDetails

setContainerDetails

Details about the container where the content being inspected is from.

Parameter
Name Description
var Google\Cloud\Dlp\V2\Container
Returns
Type Description
$this

getFileOffset

Offset in bytes of the line, from the beginning of the file, where the finding is located. Populate if the item being scanned is only part of a bigger item, such as a shard of a file and you want to track the absolute position of the finding.

Returns
Type Description
int|string

setFileOffset

Offset in bytes of the line, from the beginning of the file, where the finding is located. Populate if the item being scanned is only part of a bigger item, such as a shard of a file and you want to track the absolute position of the finding.

Parameter
Name Description
var int|string
Returns
Type Description
$this

getRowOffset

Offset of the row for tables. Populate if the row(s) being scanned are part of a bigger dataset and you want to keep track of their absolute position.

Returns
Type Description
int|string

setRowOffset

Offset of the row for tables. Populate if the row(s) being scanned are part of a bigger dataset and you want to keep track of their absolute position.

Parameter
Name Description
var int|string
Returns
Type Description
$this

getTableOptions

If the container is a table, additional information to make findings meaningful such as the columns that are primary keys. If not known ahead of time, can also be set within each inspect hybrid call and the two will be merged. Note that identifying_fields will only be stored to BigQuery, and only if the BigQuery action has been included.

Returns
Type Description
Google\Cloud\Dlp\V2\TableOptions|null

hasTableOptions

clearTableOptions

setTableOptions

If the container is a table, additional information to make findings meaningful such as the columns that are primary keys. If not known ahead of time, can also be set within each inspect hybrid call and the two will be merged. Note that identifying_fields will only be stored to BigQuery, and only if the BigQuery action has been included.

Parameter
Name Description
var Google\Cloud\Dlp\V2\TableOptions
Returns
Type Description
$this

getLabels

Labels to represent user provided metadata about the data being inspected.

If configured by the job, some key values may be required. The labels associated with Finding's produced by hybrid inspection. 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
Type Description
Google\Protobuf\Internal\MapField

setLabels

Labels to represent user provided metadata about the data being inspected.

If configured by the job, some key values may be required. The labels associated with Finding's produced by hybrid inspection. 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
Name Description
var array|Google\Protobuf\Internal\MapField
Returns
Type Description
$this