file_store_data_profiles

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

Overview

Name	file_store_data_profiles
Type	Resource
Id	google.dlp.file_store_data_profiles

Fields

The following fields are returned by SELECT queries:

projects_locations_file_store_data_profiles_get

Successful response

Name	Datatype	Description
name	string	The name of the profile.
configSnapshot	object	The snapshot of the configurations used to generate the profile. (id: GooglePrivacyDlpV2DataProfileConfigSnapshot)
createTime	string (google-datetime)	The time the file store was first created.
dataRiskLevel	object	The data risk level of this resource. (id: GooglePrivacyDlpV2DataRiskLevel)
dataSourceType	object	The resource type that was profiled. (id: GooglePrivacyDlpV2DataSourceType)
dataStorageLocations	array	For resources that have multiple storage locations, these are those regions. For Cloud Storage this is the list of regions chosen for dual-region storage. file_store_location will normally be the corresponding multi-region for the list of individual locations. The first region is always picked as the processing and storage location for the data profile.
domains	array	Domains associated with the profile.
fileClusterSummaries	array	FileClusterSummary per each cluster.
fileStoreInfoTypeSummaries	array	InfoTypes detected in this file store.
fileStoreIsEmpty	boolean	The file store does not have any files. If the profiling operation failed, this is false.
fileStoreLocation	string	The location of the file store. * Cloud Storage: https://cloud.google.com/storage/docs/locations#available-locations * Amazon S3: https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints
fileStorePath	string	The file store path. * Cloud Storage: gs://{bucket} * Amazon S3: s3://{bucket} * Vertex AI dataset: projects/{project_number}/locations/{location}/datasets/{dataset_id}
fullResource	string	The resource name of the resource profiled. https://cloud.google.com/apis/design/resource_names#full_resource_name Example format of an S3 bucket full resource name: //cloudasset.googleapis.com/organizations/{org_id}/otherCloudConnections/aws/arn:aws:s3:::{bucket_name}
lastModifiedTime	string (google-datetime)	The time the file store was last modified.
locationType	string	The location type of the file store (region, dual-region, multi-region, etc). If dual-region, expect data_storage_locations to be populated.
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)
projectDataProfile	string	The resource name of the project data profile for this file store.
projectId	string	The Google Cloud project ID that owns the resource. For Amazon S3 buckets, this is the AWS Account Id.
relatedResources	array	Resources related to this profile.
resourceAttributes	object	Attributes of the resource being profiled. Currently used attributes: * customer_managed_encryption: boolean - true: the resource is encrypted with a customer-managed key. - false: the resource is encrypted with a provider-managed key.
resourceLabels	object	The labels applied to the resource at the time the profile was generated.
resourceVisibility	string	How broadly a resource has been shared.
sampleFindingsTable	object	The BigQuery table to which the sample findings are written. (id: GooglePrivacyDlpV2BigQueryTable)
sensitivityScore	object	The sensitivity score of this resource. (id: GooglePrivacyDlpV2SensitivityScore)
state	string	State of a profile.
tags	array	The tags attached to the resource, including any tags attached during profiling.

organizations_locations_file_store_data_profiles_get

Successful response

Name	Datatype	Description
name	string	The name of the profile.
configSnapshot	object	The snapshot of the configurations used to generate the profile. (id: GooglePrivacyDlpV2DataProfileConfigSnapshot)
createTime	string (google-datetime)	The time the file store was first created.
dataRiskLevel	object	The data risk level of this resource. (id: GooglePrivacyDlpV2DataRiskLevel)
dataSourceType	object	The resource type that was profiled. (id: GooglePrivacyDlpV2DataSourceType)
dataStorageLocations	array	For resources that have multiple storage locations, these are those regions. For Cloud Storage this is the list of regions chosen for dual-region storage. file_store_location will normally be the corresponding multi-region for the list of individual locations. The first region is always picked as the processing and storage location for the data profile.
domains	array	Domains associated with the profile.
fileClusterSummaries	array	FileClusterSummary per each cluster.
fileStoreInfoTypeSummaries	array	InfoTypes detected in this file store.
fileStoreIsEmpty	boolean	The file store does not have any files. If the profiling operation failed, this is false.
fileStoreLocation	string	The location of the file store. * Cloud Storage: https://cloud.google.com/storage/docs/locations#available-locations * Amazon S3: https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints
fileStorePath	string	The file store path. * Cloud Storage: gs://{bucket} * Amazon S3: s3://{bucket} * Vertex AI dataset: projects/{project_number}/locations/{location}/datasets/{dataset_id}
fullResource	string	The resource name of the resource profiled. https://cloud.google.com/apis/design/resource_names#full_resource_name Example format of an S3 bucket full resource name: //cloudasset.googleapis.com/organizations/{org_id}/otherCloudConnections/aws/arn:aws:s3:::{bucket_name}
lastModifiedTime	string (google-datetime)	The time the file store was last modified.
locationType	string	The location type of the file store (region, dual-region, multi-region, etc). If dual-region, expect data_storage_locations to be populated.
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)
projectDataProfile	string	The resource name of the project data profile for this file store.
projectId	string	The Google Cloud project ID that owns the resource. For Amazon S3 buckets, this is the AWS Account Id.
relatedResources	array	Resources related to this profile.
resourceAttributes	object	Attributes of the resource being profiled. Currently used attributes: * customer_managed_encryption: boolean - true: the resource is encrypted with a customer-managed key. - false: the resource is encrypted with a provider-managed key.
resourceLabels	object	The labels applied to the resource at the time the profile was generated.
resourceVisibility	string	How broadly a resource has been shared.
sampleFindingsTable	object	The BigQuery table to which the sample findings are written. (id: GooglePrivacyDlpV2BigQueryTable)
sensitivityScore	object	The sensitivity score of this resource. (id: GooglePrivacyDlpV2SensitivityScore)
state	string	State of a profile.
tags	array	The tags attached to the resource, including any tags attached during profiling.

projects_locations_file_store_data_profiles_list

Successful response

Name	Datatype	Description
name	string	The name of the profile.
configSnapshot	object	The snapshot of the configurations used to generate the profile. (id: GooglePrivacyDlpV2DataProfileConfigSnapshot)
createTime	string (google-datetime)	The time the file store was first created.
dataRiskLevel	object	The data risk level of this resource. (id: GooglePrivacyDlpV2DataRiskLevel)
dataSourceType	object	The resource type that was profiled. (id: GooglePrivacyDlpV2DataSourceType)
dataStorageLocations	array	For resources that have multiple storage locations, these are those regions. For Cloud Storage this is the list of regions chosen for dual-region storage. file_store_location will normally be the corresponding multi-region for the list of individual locations. The first region is always picked as the processing and storage location for the data profile.
domains	array	Domains associated with the profile.
fileClusterSummaries	array	FileClusterSummary per each cluster.
fileStoreInfoTypeSummaries	array	InfoTypes detected in this file store.
fileStoreIsEmpty	boolean	The file store does not have any files. If the profiling operation failed, this is false.
fileStoreLocation	string	The location of the file store. * Cloud Storage: https://cloud.google.com/storage/docs/locations#available-locations * Amazon S3: https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints
fileStorePath	string	The file store path. * Cloud Storage: gs://{bucket} * Amazon S3: s3://{bucket} * Vertex AI dataset: projects/{project_number}/locations/{location}/datasets/{dataset_id}
fullResource	string	The resource name of the resource profiled. https://cloud.google.com/apis/design/resource_names#full_resource_name Example format of an S3 bucket full resource name: //cloudasset.googleapis.com/organizations/{org_id}/otherCloudConnections/aws/arn:aws:s3:::{bucket_name}
lastModifiedTime	string (google-datetime)	The time the file store was last modified.
locationType	string	The location type of the file store (region, dual-region, multi-region, etc). If dual-region, expect data_storage_locations to be populated.
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)
projectDataProfile	string	The resource name of the project data profile for this file store.
projectId	string	The Google Cloud project ID that owns the resource. For Amazon S3 buckets, this is the AWS Account Id.
relatedResources	array	Resources related to this profile.
resourceAttributes	object	Attributes of the resource being profiled. Currently used attributes: * customer_managed_encryption: boolean - true: the resource is encrypted with a customer-managed key. - false: the resource is encrypted with a provider-managed key.
resourceLabels	object	The labels applied to the resource at the time the profile was generated.
resourceVisibility	string	How broadly a resource has been shared.
sampleFindingsTable	object	The BigQuery table to which the sample findings are written. (id: GooglePrivacyDlpV2BigQueryTable)
sensitivityScore	object	The sensitivity score of this resource. (id: GooglePrivacyDlpV2SensitivityScore)
state	string	State of a profile.
tags	array	The tags attached to the resource, including any tags attached during profiling.

organizations_locations_file_store_data_profiles_list

Successful response

Name	Datatype	Description
name	string	The name of the profile.
configSnapshot	object	The snapshot of the configurations used to generate the profile. (id: GooglePrivacyDlpV2DataProfileConfigSnapshot)
createTime	string (google-datetime)	The time the file store was first created.
dataRiskLevel	object	The data risk level of this resource. (id: GooglePrivacyDlpV2DataRiskLevel)
dataSourceType	object	The resource type that was profiled. (id: GooglePrivacyDlpV2DataSourceType)
dataStorageLocations	array	For resources that have multiple storage locations, these are those regions. For Cloud Storage this is the list of regions chosen for dual-region storage. file_store_location will normally be the corresponding multi-region for the list of individual locations. The first region is always picked as the processing and storage location for the data profile.
domains	array	Domains associated with the profile.
fileClusterSummaries	array	FileClusterSummary per each cluster.
fileStoreInfoTypeSummaries	array	InfoTypes detected in this file store.
fileStoreIsEmpty	boolean	The file store does not have any files. If the profiling operation failed, this is false.
fileStoreLocation	string	The location of the file store. * Cloud Storage: https://cloud.google.com/storage/docs/locations#available-locations * Amazon S3: https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints
fileStorePath	string	The file store path. * Cloud Storage: gs://{bucket} * Amazon S3: s3://{bucket} * Vertex AI dataset: projects/{project_number}/locations/{location}/datasets/{dataset_id}
fullResource	string	The resource name of the resource profiled. https://cloud.google.com/apis/design/resource_names#full_resource_name Example format of an S3 bucket full resource name: //cloudasset.googleapis.com/organizations/{org_id}/otherCloudConnections/aws/arn:aws:s3:::{bucket_name}
lastModifiedTime	string (google-datetime)	The time the file store was last modified.
locationType	string	The location type of the file store (region, dual-region, multi-region, etc). If dual-region, expect data_storage_locations to be populated.
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)
projectDataProfile	string	The resource name of the project data profile for this file store.
projectId	string	The Google Cloud project ID that owns the resource. For Amazon S3 buckets, this is the AWS Account Id.
relatedResources	array	Resources related to this profile.
resourceAttributes	object	Attributes of the resource being profiled. Currently used attributes: * customer_managed_encryption: boolean - true: the resource is encrypted with a customer-managed key. - false: the resource is encrypted with a provider-managed key.
resourceLabels	object	The labels applied to the resource at the time the profile was generated.
resourceVisibility	string	How broadly a resource has been shared.
sampleFindingsTable	object	The BigQuery table to which the sample findings are written. (id: GooglePrivacyDlpV2BigQueryTable)
sensitivityScore	object	The sensitivity score of this resource. (id: GooglePrivacyDlpV2SensitivityScore)
state	string	State of a profile.
tags	array	The tags attached to the resource, including any tags attached during profiling.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
projects_locations_file_store_data_profiles_get	select	projectsId, locationsId, fileStoreDataProfilesId		Gets a file store data profile.
organizations_locations_file_store_data_profiles_get	select	organizationsId, locationsId, fileStoreDataProfilesId		Gets a file store data profile.
projects_locations_file_store_data_profiles_list	select	projectsId, locationsId	pageToken, pageSize, orderBy, filter	Lists file store data profiles for an organization.
organizations_locations_file_store_data_profiles_list	select	organizationsId, locationsId	pageToken, pageSize, orderBy, filter	Lists file store data profiles for an organization.
projects_locations_file_store_data_profiles_delete	delete	projectsId, locationsId, fileStoreDataProfilesId		Delete a FileStoreDataProfile. Will not prevent the profile from being regenerated if the resource is still included in a discovery configuration.
organizations_locations_file_store_data_profiles_delete	delete	organizationsId, locationsId, fileStoreDataProfilesId		Delete a FileStoreDataProfile. Will not prevent the profile from being regenerated if the resource 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.

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

SELECT examples

projects_locations_file_store_data_profiles_get

Gets a file store data profile.

SELECT
name,
configSnapshot,
createTime,
dataRiskLevel,
dataSourceType,
dataStorageLocations,
domains,
fileClusterSummaries,
fileStoreInfoTypeSummaries,
fileStoreIsEmpty,
fileStoreLocation,
fileStorePath,
fullResource,
lastModifiedTime,
locationType,
profileLastGenerated,
profileStatus,
projectDataProfile,
projectId,
relatedResources,
resourceAttributes,
resourceLabels,
resourceVisibility,
sampleFindingsTable,
sensitivityScore,
state,
tags
FROM google.dlp.file_store_data_profiles
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND fileStoreDataProfilesId = '{{ fileStoreDataProfilesId }}' -- required;

organizations_locations_file_store_data_profiles_get

Gets a file store data profile.

SELECT
name,
configSnapshot,
createTime,
dataRiskLevel,
dataSourceType,
dataStorageLocations,
domains,
fileClusterSummaries,
fileStoreInfoTypeSummaries,
fileStoreIsEmpty,
fileStoreLocation,
fileStorePath,
fullResource,
lastModifiedTime,
locationType,
profileLastGenerated,
profileStatus,
projectDataProfile,
projectId,
relatedResources,
resourceAttributes,
resourceLabels,
resourceVisibility,
sampleFindingsTable,
sensitivityScore,
state,
tags
FROM google.dlp.file_store_data_profiles
WHERE organizationsId = '{{ organizationsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND fileStoreDataProfilesId = '{{ fileStoreDataProfilesId }}' -- required;

projects_locations_file_store_data_profiles_list

Lists file store data profiles for an organization.

SELECT
name,
configSnapshot,
createTime,
dataRiskLevel,
dataSourceType,
dataStorageLocations,
domains,
fileClusterSummaries,
fileStoreInfoTypeSummaries,
fileStoreIsEmpty,
fileStoreLocation,
fileStorePath,
fullResource,
lastModifiedTime,
locationType,
profileLastGenerated,
profileStatus,
projectDataProfile,
projectId,
relatedResources,
resourceAttributes,
resourceLabels,
resourceVisibility,
sampleFindingsTable,
sensitivityScore,
state,
tags
FROM google.dlp.file_store_data_profiles
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageToken = '{{ pageToken }}'
AND pageSize = '{{ pageSize }}'
AND orderBy = '{{ orderBy }}'
AND filter = '{{ filter }}';

organizations_locations_file_store_data_profiles_list

Lists file store data profiles for an organization.

SELECT
name,
configSnapshot,
createTime,
dataRiskLevel,
dataSourceType,
dataStorageLocations,
domains,
fileClusterSummaries,
fileStoreInfoTypeSummaries,
fileStoreIsEmpty,
fileStoreLocation,
fileStorePath,
fullResource,
lastModifiedTime,
locationType,
profileLastGenerated,
profileStatus,
projectDataProfile,
projectId,
relatedResources,
resourceAttributes,
resourceLabels,
resourceVisibility,
sampleFindingsTable,
sensitivityScore,
state,
tags
FROM google.dlp.file_store_data_profiles
WHERE organizationsId = '{{ organizationsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageToken = '{{ pageToken }}'
AND pageSize = '{{ pageSize }}'
AND orderBy = '{{ orderBy }}'
AND filter = '{{ filter }}';

DELETE examples

projects_locations_file_store_data_profiles_delete

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

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

organizations_locations_file_store_data_profiles_delete

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

DELETE FROM google.dlp.file_store_data_profiles
WHERE organizationsId = '{{ organizationsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND fileStoreDataProfilesId = '{{ fileStoreDataProfilesId }}' --required;