Skip to main content

table_data_profiles

Creates, updates, deletes, gets or lists a table_data_profiles resource.

Overview

Nametable_data_profiles
TypeResource
Idgoogle.dlp.table_data_profiles

Fields

The following fields are returned by SELECT queries:

Successful response

NameDatatypeDescription
namestringThe name of the profile.
configSnapshotobjectThe snapshot of the configurations used to generate the profile. (id: GooglePrivacyDlpV2DataProfileConfigSnapshot)
createTimestring (google-datetime)The time at which the table was created.
dataRiskLevelobjectThe data risk level of this table. (id: GooglePrivacyDlpV2DataRiskLevel)
dataSourceTypeobjectThe resource type that was profiled. (id: GooglePrivacyDlpV2DataSourceType)
datasetIdstringIf the resource is BigQuery, the dataset ID.
datasetLocationstringIf supported, the location where the dataset's data is stored. See https://cloud.google.com/bigquery/docs/locations for supported locations.
datasetProjectIdstringThe Google Cloud project ID that owns the resource.
domainsarrayDomains associated with the profile.
encryptionStatusstringHow the table is encrypted.
expirationTimestring (google-datetime)Optional. The time when this table expires.
failedColumnCountstring (int64)The number of columns skipped in the table because of an error.
fullResourcestringThe Cloud Asset Inventory resource that was profiled in order to generate this TableDataProfile. https://cloud.google.com/apis/design/resource_names#full_resource_name
lastModifiedTimestring (google-datetime)The time when this table was last modified
otherInfoTypesarrayOther infoTypes found in this table's data.
predictedInfoTypesarrayThe infoTypes predicted from this table's data.
profileLastGeneratedstring (google-datetime)The last time the profile was generated.
profileStatusobjectSuccess or error status from the most recent profile generation attempt. May be empty if the profile is still being generated. (id: GooglePrivacyDlpV2ProfileStatus)
projectDataProfilestringThe resource name of the project data profile for this table.
relatedResourcesarrayResources related to this profile.
resourceLabelsobjectThe labels applied to the resource at the time the profile was generated.
resourceVisibilitystringHow broadly a resource has been shared.
rowCountstring (int64)Number of rows in the table when the profile was generated. This will not be populated for BigLake tables.
sampleFindingsTableobjectThe BigQuery table to which the sample findings are written. (id: GooglePrivacyDlpV2BigQueryTable)
scannedColumnCountstring (int64)The number of columns profiled in the table.
sensitivityScoreobjectThe sensitivity score of this table. (id: GooglePrivacyDlpV2SensitivityScore)
statestringState of a profile. This will always be set to DONE when the table data profile is written to another service like BigQuery or Pub/Sub.
tableIdstringThe table ID.
tableSizeBytesstring (int64)The size of the table when the profile was generated.
tagsarrayThe tags attached to the table, including any tags attached during profiling. Because tags are attached to Cloud SQL instances rather than Cloud SQL tables, this field is empty for Cloud SQL table profiles.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
projects_locations_table_data_profiles_getselectprojectsId, locationsId, tableDataProfilesIdGets a table data profile.
organizations_locations_table_data_profiles_getselectorganizationsId, locationsId, tableDataProfilesIdGets a table data profile.
projects_locations_table_data_profiles_listselectprojectsId, locationsIdpageToken, pageSize, orderBy, filterLists table data profiles for an organization.
organizations_locations_table_data_profiles_listselectorganizationsId, locationsIdpageToken, pageSize, orderBy, filterLists table data profiles for an organization.
projects_locations_table_data_profiles_deletedeleteprojectsId, locationsId, tableDataProfilesIdDelete a TableDataProfile. Will not prevent the profile from being regenerated if the table is still included in a discovery configuration.
organizations_locations_table_data_profiles_deletedeleteorganizationsId, locationsId, tableDataProfilesIdDelete a TableDataProfile. Will not prevent the profile from being regenerated if the table is still included in a discovery configuration.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
locationsIdstring
organizationsIdstring
projectsIdstring
tableDataProfilesIdstring
filterstring
orderBystring
pageSizeinteger (int32)
pageTokenstring

SELECT examples

Gets a table data profile.

SELECT
name,
configSnapshot,
createTime,
dataRiskLevel,
dataSourceType,
datasetId,
datasetLocation,
datasetProjectId,
domains,
encryptionStatus,
expirationTime,
failedColumnCount,
fullResource,
lastModifiedTime,
otherInfoTypes,
predictedInfoTypes,
profileLastGenerated,
profileStatus,
projectDataProfile,
relatedResources,
resourceLabels,
resourceVisibility,
rowCount,
sampleFindingsTable,
scannedColumnCount,
sensitivityScore,
state,
tableId,
tableSizeBytes,
tags
FROM google.dlp.table_data_profiles
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND tableDataProfilesId = '{{ tableDataProfilesId }}' -- required;

DELETE examples

Delete a TableDataProfile. Will not prevent the profile from being regenerated if the table is still included in a discovery configuration.

DELETE FROM google.dlp.table_data_profiles
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND tableDataProfilesId = '{{ tableDataProfilesId }}' --required;