Data Loss Prevention V2 Client - Class ColumnDataProfile (2.6.1)

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

The profile for a scanned column within a table.

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

Namespace

Google \ Cloud \ Dlp \ V2

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ name
string

The name of the profile.

↳ profile_status
ProfileStatus

Success or error status from the most recent profile generation attempt. May be empty if the profile is still being generated.

↳ state
int

State of a profile.

↳ profile_last_generated
Google\Protobuf\Timestamp

The last time the profile was generated.

↳ table_data_profile
string

The resource name of the table data profile.

↳ table_full_resource
string

The resource name of the resource this column is within.

↳ dataset_project_id
string

The Google Cloud project ID that owns the profiled resource.

↳ dataset_location
string

If supported, the location where the dataset's data is stored. See https://cloud.google.com/bigquery/docs/locations for supported BigQuery locations.

↳ dataset_id
string

The BigQuery dataset ID, if the resource profiled is a BigQuery table.

↳ table_id
string

The table ID.

↳ column
string

The name of the column.

↳ sensitivity_score
SensitivityScore

The sensitivity of this column.

↳ data_risk_level
DataRiskLevel

The data risk level for this column.

↳ column_info_type
InfoTypeSummary

If it's been determined this column can be identified as a single type, this will be set. Otherwise the column either has unidentifiable content or mixed types.

↳ other_matches
array< OtherInfoTypeSummary >

Other types found within this column. List will be unordered.

↳ estimated_null_percentage
int

Approximate percentage of entries being null in the column.

↳ estimated_uniqueness_score
int

Approximate uniqueness of the column.

↳ free_text_score
float

The likelihood that this column contains free-form text. A value close to 1 may indicate the column is likely to contain free-form or natural language text. Range in 0-1.

↳ column_type
int

The data type of a given column.

↳ policy_state
int

Indicates if a policy tag has been applied to the column.

getName

The name of the profile.

Returns
Type
Description
string

setName

The name of the profile.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getProfileStatus

Success or error status from the most recent profile generation attempt.

May be empty if the profile is still being generated.

Returns
Type
Description

hasProfileStatus

clearProfileStatus

setProfileStatus

Success or error status from the most recent profile generation attempt.

May be empty if the profile is still being generated.

Parameter
Name
Description
Returns
Type
Description
$this

getState

State of a profile.

Returns
Type
Description
int

setState

State of a profile.

Parameter
Name
Description
var
int
Returns
Type
Description
$this

getProfileLastGenerated

The last time the profile was generated.

Returns
Type
Description

hasProfileLastGenerated

clearProfileLastGenerated

setProfileLastGenerated

The last time the profile was generated.

Parameter
Name
Description
Returns
Type
Description
$this

getTableDataProfile

The resource name of the table data profile.

Returns
Type
Description
string

setTableDataProfile

The resource name of the table data profile.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getTableFullResource

The resource name of the resource this column is within.

Returns
Type
Description
string

setTableFullResource

The resource name of the resource this column is within.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getDatasetProjectId

The Google Cloud project ID that owns the profiled resource.

Returns
Type
Description
string

setDatasetProjectId

The Google Cloud project ID that owns the profiled resource.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getDatasetLocation

If supported, the location where the dataset's data is stored.

See https://cloud.google.com/bigquery/docs/locations for supported BigQuery locations.

Returns
Type
Description
string

setDatasetLocation

If supported, the location where the dataset's data is stored.

See https://cloud.google.com/bigquery/docs/locations for supported BigQuery locations.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getDatasetId

The BigQuery dataset ID, if the resource profiled is a BigQuery table.

Returns
Type
Description
string

setDatasetId

The BigQuery dataset ID, if the resource profiled is a BigQuery table.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getTableId

The table ID.

Returns
Type
Description
string

setTableId

The table ID.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getColumn

The name of the column.

Returns
Type
Description
string

setColumn

The name of the column.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getSensitivityScore

The sensitivity of this column.

Returns
Type
Description

hasSensitivityScore

clearSensitivityScore

setSensitivityScore

The sensitivity of this column.

Parameter
Name
Description
Returns
Type
Description
$this

getDataRiskLevel

The data risk level for this column.

Returns
Type
Description

hasDataRiskLevel

clearDataRiskLevel

setDataRiskLevel

The data risk level for this column.

Parameter
Name
Description
Returns
Type
Description
$this

getColumnInfoType

If it's been determined this column can be identified as a single type, this will be set. Otherwise the column either has unidentifiable content or mixed types.

Returns
Type
Description

hasColumnInfoType

clearColumnInfoType

setColumnInfoType

If it's been determined this column can be identified as a single type, this will be set. Otherwise the column either has unidentifiable content or mixed types.

Parameter
Name
Description
Returns
Type
Description
$this

getOtherMatches

Other types found within this column. List will be unordered.

Returns
Type
Description

setOtherMatches

Other types found within this column. List will be unordered.

Parameter
Name
Description
var
Returns
Type
Description
$this

getEstimatedNullPercentage

Approximate percentage of entries being null in the column.

Returns
Type
Description
int

setEstimatedNullPercentage

Approximate percentage of entries being null in the column.

Parameter
Name
Description
var
int
Returns
Type
Description
$this

getEstimatedUniquenessScore

Approximate uniqueness of the column.

Returns
Type
Description
int

setEstimatedUniquenessScore

Approximate uniqueness of the column.

Parameter
Name
Description
var
int
Returns
Type
Description
$this

getFreeTextScore

The likelihood that this column contains free-form text.

A value close to 1 may indicate the column is likely to contain free-form or natural language text. Range in 0-1.

Returns
Type
Description
float

setFreeTextScore

The likelihood that this column contains free-form text.

A value close to 1 may indicate the column is likely to contain free-form or natural language text. Range in 0-1.

Parameter
Name
Description
var
float
Returns
Type
Description
$this

getColumnType

The data type of a given column.

Returns
Type
Description
int

setColumnType

The data type of a given column.

Parameter
Name
Description
var
int
Returns
Type
Description
$this

getPolicyState

Indicates if a policy tag has been applied to the column.

Returns
Type
Description
int

setPolicyState

Indicates if a policy tag has been applied to the column.

Parameter
Name
Description
var
int
Returns
Type
Description
$this
Create a Mobile Website
View Site in Mobile | Classic
Share by: