Reference documentation and code samples for the Data Loss Prevention V2 Client class TableDataProfile.
The profile for a scanned table.
Generated from protobuf message google.privacy.dlp.v2.TableDataProfile
Namespace
Google \ Cloud \ Dlp \ V2Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
The name of the profile. |
↳ data_source_type |
Google\Cloud\Dlp\V2\DataSourceType
The resource type that was profiled. |
↳ project_data_profile |
string
The resource name to the project data profile for this table. |
↳ dataset_project_id |
string
The Google Cloud project ID that owns the 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 locations. |
↳ dataset_id |
string
If the resource is BigQuery, the dataset ID. |
↳ table_id |
string
If the resource is BigQuery, the BigQuery table ID. |
↳ full_resource |
string
The resource name of the resource profiled. https://cloud.google.com/apis/design/resource_names#full_resource_name |
↳ profile_status |
Google\Cloud\Dlp\V2\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. |
↳ sensitivity_score |
Google\Cloud\Dlp\V2\SensitivityScore
The sensitivity score of this table. |
↳ data_risk_level |
Google\Cloud\Dlp\V2\DataRiskLevel
The data risk level of this table. |
↳ predicted_info_types |
array<Google\Cloud\Dlp\V2\InfoTypeSummary>
The infoTypes predicted from this table's data. |
↳ other_info_types |
array<Google\Cloud\Dlp\V2\OtherInfoTypeSummary>
Other infoTypes found in this table's data. |
↳ config_snapshot |
Google\Cloud\Dlp\V2\DataProfileConfigSnapshot
The snapshot of the configurations used to generate the profile. |
↳ last_modified_time |
Google\Protobuf\Timestamp
The time when this table was last modified |
↳ expiration_time |
Google\Protobuf\Timestamp
Optional. The time when this table expires. |
↳ scanned_column_count |
int|string
The number of columns profiled in the table. |
↳ failed_column_count |
int|string
The number of columns skipped in the table because of an error. |
↳ table_size_bytes |
int|string
The size of the table when the profile was generated. |
↳ row_count |
int|string
Number of rows in the table when the profile was generated. This will not be populated for BigLake tables. |
↳ encryption_status |
int
How the table is encrypted. |
↳ resource_visibility |
int
How broadly a resource has been shared. |
↳ profile_last_generated |
Google\Protobuf\Timestamp
The last time the profile was generated. |
↳ resource_labels |
array|Google\Protobuf\Internal\MapField
The labels applied to the resource at the time the profile was generated. |
↳ create_time |
Google\Protobuf\Timestamp
The time at which the table was created. |
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 |
|
getDataSourceType
The resource type that was profiled.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dlp\V2\DataSourceType|null |
|
hasDataSourceType
clearDataSourceType
setDataSourceType
The resource type that was profiled.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Dlp\V2\DataSourceType
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getProjectDataProfile
The resource name to the project data profile for this table.
| Returns | |
|---|---|
| Type | Description |
string |
|
setProjectDataProfile
The resource name to the project data profile for this table.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDatasetProjectId
The Google Cloud project ID that owns the resource.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDatasetProjectId
The Google Cloud project ID that owns the 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 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 locations.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDatasetId
If the resource is BigQuery, the dataset ID.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDatasetId
If the resource is BigQuery, the dataset ID.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTableId
If the resource is BigQuery, the BigQuery table ID.
| Returns | |
|---|---|
| Type | Description |
string |
|
setTableId
If the resource is BigQuery, the BigQuery table ID.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getFullResource
The resource name of the resource profiled.
https://cloud.google.com/apis/design/resource_names#full_resource_name
| Returns | |
|---|---|
| Type | Description |
string |
|
setFullResource
The resource name of the resource profiled.
https://cloud.google.com/apis/design/resource_names#full_resource_name
| 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 |
Google\Cloud\Dlp\V2\ProfileStatus|null |
|
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 |
var |
Google\Cloud\Dlp\V2\ProfileStatus
|
| 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 |
|
getSensitivityScore
The sensitivity score of this table.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dlp\V2\SensitivityScore|null |
|
hasSensitivityScore
clearSensitivityScore
setSensitivityScore
The sensitivity score of this table.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Dlp\V2\SensitivityScore
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDataRiskLevel
The data risk level of this table.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dlp\V2\DataRiskLevel|null |
|
hasDataRiskLevel
clearDataRiskLevel
setDataRiskLevel
The data risk level of this table.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Dlp\V2\DataRiskLevel
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPredictedInfoTypes
The infoTypes predicted from this table's data.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setPredictedInfoTypes
The infoTypes predicted from this table's data.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\Dlp\V2\InfoTypeSummary>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getOtherInfoTypes
Other infoTypes found in this table's data.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setOtherInfoTypes
Other infoTypes found in this table's data.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\Dlp\V2\OtherInfoTypeSummary>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getConfigSnapshot
The snapshot of the configurations used to generate the profile.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dlp\V2\DataProfileConfigSnapshot|null |
|
hasConfigSnapshot
clearConfigSnapshot
setConfigSnapshot
The snapshot of the configurations used to generate the profile.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Dlp\V2\DataProfileConfigSnapshot
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLastModifiedTime
The time when this table was last modified
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasLastModifiedTime
clearLastModifiedTime
setLastModifiedTime
The time when this table was last modified
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getExpirationTime
Optional. The time when this table expires.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasExpirationTime
clearExpirationTime
setExpirationTime
Optional. The time when this table expires.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getScannedColumnCount
The number of columns profiled in the table.
| Returns | |
|---|---|
| Type | Description |
int|string |
|
setScannedColumnCount
The number of columns profiled in the table.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getFailedColumnCount
The number of columns skipped in the table because of an error.
| Returns | |
|---|---|
| Type | Description |
int|string |
|
setFailedColumnCount
The number of columns skipped in the table because of an error.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTableSizeBytes
The size of the table when the profile was generated.
| Returns | |
|---|---|
| Type | Description |
int|string |
|
setTableSizeBytes
The size of the table when the profile was generated.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRowCount
Number of rows in the table when the profile was generated.
This will not be populated for BigLake tables.
| Returns | |
|---|---|
| Type | Description |
int|string |
|
setRowCount
Number of rows in the table when the profile was generated.
This will not be populated for BigLake tables.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEncryptionStatus
How the table is encrypted.
| Returns | |
|---|---|
| Type | Description |
int |
|
setEncryptionStatus
How the table is encrypted.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getResourceVisibility
How broadly a resource has been shared.
| Returns | |
|---|---|
| Type | Description |
int |
|
setResourceVisibility
How broadly a resource has been shared.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getProfileLastGenerated
The last time the profile was generated.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasProfileLastGenerated
clearProfileLastGenerated
setProfileLastGenerated
The last time the profile was generated.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getResourceLabels
The labels applied to the resource at the time the profile was generated.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField |
|
setResourceLabels
The labels applied to the resource at the time the profile was generated.
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCreateTime
The time at which the table was created.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasCreateTime
clearCreateTime
setCreateTime
The time at which the table was created.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|