column_data_profiles

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

Overview

Name	column_data_profiles
Type	Resource
Id	google.dlp.column_data_profiles

Fields

The following fields are returned by SELECT queries:

projects_locations_column_data_profiles_get

Successful response

Name	Datatype	Description
name	string	The name of the profile.
column	string	The name of the column.
columnInfoType	object	The infoType details for this column. (id: GooglePrivacyDlpV2InfoTypeSummary)
columnType	string	The data type of a given column.
dataRiskLevel	object	The data risk level for this column. (id: GooglePrivacyDlpV2DataRiskLevel)
datasetId	string	The BigQuery dataset ID, if the resource profiled is a BigQuery table.
datasetLocation	string	If supported, the location where the dataset's data is stored. See https://cloud.google.com/bigquery/docs/locations for supported BigQuery locations.
datasetProjectId	string	The Google Cloud project ID that owns the profiled resource.
estimatedNullPercentage	string	Approximate percentage of entries being null in the column.
estimatedUniquenessScore	string	Approximate uniqueness of the column.
freeTextScore	number (double)	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.
otherMatches	array	Other types found within this column. List will be unordered.
policyState	string	Indicates if a policy tag has been applied to the column.
profileLastGenerated	string (google-datetime)	The last time the profile was generated.
profileStatus	object	Success or error status from the most recent profile generation attempt. May be empty if the profile is still being generated. (id: GooglePrivacyDlpV2ProfileStatus)
sensitivityScore	object	The sensitivity of this column. (id: GooglePrivacyDlpV2SensitivityScore)
state	string	State of a profile.
tableDataProfile	string	The resource name of the table data profile.
tableFullResource	string	The resource name of the resource this column is within.
tableId	string	The table ID.

organizations_locations_column_data_profiles_get

Successful response

Name	Datatype	Description
name	string	The name of the profile.
column	string	The name of the column.
columnInfoType	object	The infoType details for this column. (id: GooglePrivacyDlpV2InfoTypeSummary)
columnType	string	The data type of a given column.
dataRiskLevel	object	The data risk level for this column. (id: GooglePrivacyDlpV2DataRiskLevel)
datasetId	string	The BigQuery dataset ID, if the resource profiled is a BigQuery table.
datasetLocation	string	If supported, the location where the dataset's data is stored. See https://cloud.google.com/bigquery/docs/locations for supported BigQuery locations.
datasetProjectId	string	The Google Cloud project ID that owns the profiled resource.
estimatedNullPercentage	string	Approximate percentage of entries being null in the column.
estimatedUniquenessScore	string	Approximate uniqueness of the column.
freeTextScore	number (double)	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.
otherMatches	array	Other types found within this column. List will be unordered.
policyState	string	Indicates if a policy tag has been applied to the column.
profileLastGenerated	string (google-datetime)	The last time the profile was generated.
profileStatus	object	Success or error status from the most recent profile generation attempt. May be empty if the profile is still being generated. (id: GooglePrivacyDlpV2ProfileStatus)
sensitivityScore	object	The sensitivity of this column. (id: GooglePrivacyDlpV2SensitivityScore)
state	string	State of a profile.
tableDataProfile	string	The resource name of the table data profile.
tableFullResource	string	The resource name of the resource this column is within.
tableId	string	The table ID.

projects_locations_column_data_profiles_list

Successful response

Name	Datatype	Description
name	string	The name of the profile.
column	string	The name of the column.
columnInfoType	object	The infoType details for this column. (id: GooglePrivacyDlpV2InfoTypeSummary)
columnType	string	The data type of a given column.
dataRiskLevel	object	The data risk level for this column. (id: GooglePrivacyDlpV2DataRiskLevel)
datasetId	string	The BigQuery dataset ID, if the resource profiled is a BigQuery table.
datasetLocation	string	If supported, the location where the dataset's data is stored. See https://cloud.google.com/bigquery/docs/locations for supported BigQuery locations.
datasetProjectId	string	The Google Cloud project ID that owns the profiled resource.
estimatedNullPercentage	string	Approximate percentage of entries being null in the column.
estimatedUniquenessScore	string	Approximate uniqueness of the column.
freeTextScore	number (double)	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.
otherMatches	array	Other types found within this column. List will be unordered.
policyState	string	Indicates if a policy tag has been applied to the column.
profileLastGenerated	string (google-datetime)	The last time the profile was generated.
profileStatus	object	Success or error status from the most recent profile generation attempt. May be empty if the profile is still being generated. (id: GooglePrivacyDlpV2ProfileStatus)
sensitivityScore	object	The sensitivity of this column. (id: GooglePrivacyDlpV2SensitivityScore)
state	string	State of a profile.
tableDataProfile	string	The resource name of the table data profile.
tableFullResource	string	The resource name of the resource this column is within.
tableId	string	The table ID.

organizations_locations_column_data_profiles_list

Successful response

Name	Datatype	Description
name	string	The name of the profile.
column	string	The name of the column.
columnInfoType	object	The infoType details for this column. (id: GooglePrivacyDlpV2InfoTypeSummary)
columnType	string	The data type of a given column.
dataRiskLevel	object	The data risk level for this column. (id: GooglePrivacyDlpV2DataRiskLevel)
datasetId	string	The BigQuery dataset ID, if the resource profiled is a BigQuery table.
datasetLocation	string	If supported, the location where the dataset's data is stored. See https://cloud.google.com/bigquery/docs/locations for supported BigQuery locations.
datasetProjectId	string	The Google Cloud project ID that owns the profiled resource.
estimatedNullPercentage	string	Approximate percentage of entries being null in the column.
estimatedUniquenessScore	string	Approximate uniqueness of the column.
freeTextScore	number (double)	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.
otherMatches	array	Other types found within this column. List will be unordered.
policyState	string	Indicates if a policy tag has been applied to the column.
profileLastGenerated	string (google-datetime)	The last time the profile was generated.
profileStatus	object	Success or error status from the most recent profile generation attempt. May be empty if the profile is still being generated. (id: GooglePrivacyDlpV2ProfileStatus)
sensitivityScore	object	The sensitivity of this column. (id: GooglePrivacyDlpV2SensitivityScore)
state	string	State of a profile.
tableDataProfile	string	The resource name of the table data profile.
tableFullResource	string	The resource name of the resource this column is within.
tableId	string	The table ID.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
projects_locations_column_data_profiles_get	select	projectsId, locationsId, columnDataProfilesId		Gets a column data profile.
organizations_locations_column_data_profiles_get	select	organizationsId, locationsId, columnDataProfilesId		Gets a column data profile.
projects_locations_column_data_profiles_list	select	projectsId, locationsId	pageToken, pageSize, orderBy, filter	Lists column data profiles for an organization.
organizations_locations_column_data_profiles_list	select	organizationsId, locationsId	pageToken, pageSize, orderBy, filter	Lists column data profiles for an organization.

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.

Name	Datatype	Description
columnDataProfilesId	string
locationsId	string
organizationsId	string
projectsId	string
filter	string
orderBy	string
pageSize	integer (int32)
pageToken	string

SELECT examples

projects_locations_column_data_profiles_get

Gets a column data profile.

SELECT
name,
column,
columnInfoType,
columnType,
dataRiskLevel,
datasetId,
datasetLocation,
datasetProjectId,
estimatedNullPercentage,
estimatedUniquenessScore,
freeTextScore,
otherMatches,
policyState,
profileLastGenerated,
profileStatus,
sensitivityScore,
state,
tableDataProfile,
tableFullResource,
tableId
FROM google.dlp.column_data_profiles
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND columnDataProfilesId = '{{ columnDataProfilesId }}' -- required;

organizations_locations_column_data_profiles_get

Gets a column data profile.

SELECT
name,
column,
columnInfoType,
columnType,
dataRiskLevel,
datasetId,
datasetLocation,
datasetProjectId,
estimatedNullPercentage,
estimatedUniquenessScore,
freeTextScore,
otherMatches,
policyState,
profileLastGenerated,
profileStatus,
sensitivityScore,
state,
tableDataProfile,
tableFullResource,
tableId
FROM google.dlp.column_data_profiles
WHERE organizationsId = '{{ organizationsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND columnDataProfilesId = '{{ columnDataProfilesId }}' -- required;

projects_locations_column_data_profiles_list

Lists column data profiles for an organization.

SELECT
name,
column,
columnInfoType,
columnType,
dataRiskLevel,
datasetId,
datasetLocation,
datasetProjectId,
estimatedNullPercentage,
estimatedUniquenessScore,
freeTextScore,
otherMatches,
policyState,
profileLastGenerated,
profileStatus,
sensitivityScore,
state,
tableDataProfile,
tableFullResource,
tableId
FROM google.dlp.column_data_profiles
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageToken = '{{ pageToken }}'
AND pageSize = '{{ pageSize }}'
AND orderBy = '{{ orderBy }}'
AND filter = '{{ filter }}';

organizations_locations_column_data_profiles_list

Lists column data profiles for an organization.

SELECT
name,
column,
columnInfoType,
columnType,
dataRiskLevel,
datasetId,
datasetLocation,
datasetProjectId,
estimatedNullPercentage,
estimatedUniquenessScore,
freeTextScore,
otherMatches,
policyState,
profileLastGenerated,
profileStatus,
sensitivityScore,
state,
tableDataProfile,
tableFullResource,
tableId
FROM google.dlp.column_data_profiles
WHERE organizationsId = '{{ organizationsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageToken = '{{ pageToken }}'
AND pageSize = '{{ pageSize }}'
AND orderBy = '{{ orderBy }}'
AND filter = '{{ filter }}';