discovery_configs

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

Overview

Name	discovery_configs
Type	Resource
Id	google.dlp.discovery_configs

Fields

The following fields are returned by SELECT queries:

projects_locations_discovery_configs_get

Successful response

Name	Datatype	Description
name	string	Unique resource name for the DiscoveryConfig, assigned by the service when the DiscoveryConfig is created, for example projects/dlp-test-project/locations/global/discoveryConfigs/53234423.
actions	array	Actions to execute at the completion of scanning.
createTime	string (google-datetime)	Output only. The creation timestamp of a DiscoveryConfig.
displayName	string	Display name (max 100 chars)
errors	array	Output only. A stream of errors encountered when the config was activated. Repeated errors may result in the config automatically being paused. Output only field. Will return the last 100 errors. Whenever the config is modified this list will be cleared.
inspectTemplates	array	Detection logic for profile generation. Not all template features are used by Discovery. FindingLimits, include_quote and exclude_info_types have no impact on Discovery. Multiple templates may be provided if there is data in multiple regions. At most one template must be specified per-region (including "global"). Each region is scanned using the applicable template. If no region-specific template is specified, but a "global" template is specified, it will be copied to that region and used instead. If no global or region-specific template is provided for a region with data, that region's data will not be scanned. For more information, see https://cloud.google.com/sensitive-data-protection/docs/data-profiles#data-residency.
lastRunTime	string (google-datetime)	Output only. The timestamp of the last time this config was executed.
orgConfig	object	Only set when the parent is an org. (id: GooglePrivacyDlpV2OrgConfig)
otherCloudStartingLocation	object	Must be set only when scanning other clouds. (id: GooglePrivacyDlpV2OtherCloudDiscoveryStartingLocation)
processingLocation	object	Optional. Processing location configuration. Vertex AI dataset scanning will set processing_location.image_fallback_type to MultiRegionProcessing by default. (id: GooglePrivacyDlpV2ProcessingLocation)
status	string	Required. A status for this configuration.
targets	array	Target to match against for determining what to scan and how frequently.
updateTime	string (google-datetime)	Output only. The last update timestamp of a DiscoveryConfig.

organizations_locations_discovery_configs_get

Successful response

Name	Datatype	Description
name	string	Unique resource name for the DiscoveryConfig, assigned by the service when the DiscoveryConfig is created, for example projects/dlp-test-project/locations/global/discoveryConfigs/53234423.
actions	array	Actions to execute at the completion of scanning.
createTime	string (google-datetime)	Output only. The creation timestamp of a DiscoveryConfig.
displayName	string	Display name (max 100 chars)
errors	array	Output only. A stream of errors encountered when the config was activated. Repeated errors may result in the config automatically being paused. Output only field. Will return the last 100 errors. Whenever the config is modified this list will be cleared.
inspectTemplates	array	Detection logic for profile generation. Not all template features are used by Discovery. FindingLimits, include_quote and exclude_info_types have no impact on Discovery. Multiple templates may be provided if there is data in multiple regions. At most one template must be specified per-region (including "global"). Each region is scanned using the applicable template. If no region-specific template is specified, but a "global" template is specified, it will be copied to that region and used instead. If no global or region-specific template is provided for a region with data, that region's data will not be scanned. For more information, see https://cloud.google.com/sensitive-data-protection/docs/data-profiles#data-residency.
lastRunTime	string (google-datetime)	Output only. The timestamp of the last time this config was executed.
orgConfig	object	Only set when the parent is an org. (id: GooglePrivacyDlpV2OrgConfig)
otherCloudStartingLocation	object	Must be set only when scanning other clouds. (id: GooglePrivacyDlpV2OtherCloudDiscoveryStartingLocation)
processingLocation	object	Optional. Processing location configuration. Vertex AI dataset scanning will set processing_location.image_fallback_type to MultiRegionProcessing by default. (id: GooglePrivacyDlpV2ProcessingLocation)
status	string	Required. A status for this configuration.
targets	array	Target to match against for determining what to scan and how frequently.
updateTime	string (google-datetime)	Output only. The last update timestamp of a DiscoveryConfig.

projects_locations_discovery_configs_list

Successful response

Name	Datatype	Description
name	string	Unique resource name for the DiscoveryConfig, assigned by the service when the DiscoveryConfig is created, for example projects/dlp-test-project/locations/global/discoveryConfigs/53234423.
actions	array	Actions to execute at the completion of scanning.
createTime	string (google-datetime)	Output only. The creation timestamp of a DiscoveryConfig.
displayName	string	Display name (max 100 chars)
errors	array	Output only. A stream of errors encountered when the config was activated. Repeated errors may result in the config automatically being paused. Output only field. Will return the last 100 errors. Whenever the config is modified this list will be cleared.
inspectTemplates	array	Detection logic for profile generation. Not all template features are used by Discovery. FindingLimits, include_quote and exclude_info_types have no impact on Discovery. Multiple templates may be provided if there is data in multiple regions. At most one template must be specified per-region (including "global"). Each region is scanned using the applicable template. If no region-specific template is specified, but a "global" template is specified, it will be copied to that region and used instead. If no global or region-specific template is provided for a region with data, that region's data will not be scanned. For more information, see https://cloud.google.com/sensitive-data-protection/docs/data-profiles#data-residency.
lastRunTime	string (google-datetime)	Output only. The timestamp of the last time this config was executed.
orgConfig	object	Only set when the parent is an org. (id: GooglePrivacyDlpV2OrgConfig)
otherCloudStartingLocation	object	Must be set only when scanning other clouds. (id: GooglePrivacyDlpV2OtherCloudDiscoveryStartingLocation)
processingLocation	object	Optional. Processing location configuration. Vertex AI dataset scanning will set processing_location.image_fallback_type to MultiRegionProcessing by default. (id: GooglePrivacyDlpV2ProcessingLocation)
status	string	Required. A status for this configuration.
targets	array	Target to match against for determining what to scan and how frequently.
updateTime	string (google-datetime)	Output only. The last update timestamp of a DiscoveryConfig.

organizations_locations_discovery_configs_list

Successful response

Name	Datatype	Description
name	string	Unique resource name for the DiscoveryConfig, assigned by the service when the DiscoveryConfig is created, for example projects/dlp-test-project/locations/global/discoveryConfigs/53234423.
actions	array	Actions to execute at the completion of scanning.
createTime	string (google-datetime)	Output only. The creation timestamp of a DiscoveryConfig.
displayName	string	Display name (max 100 chars)
errors	array	Output only. A stream of errors encountered when the config was activated. Repeated errors may result in the config automatically being paused. Output only field. Will return the last 100 errors. Whenever the config is modified this list will be cleared.
inspectTemplates	array	Detection logic for profile generation. Not all template features are used by Discovery. FindingLimits, include_quote and exclude_info_types have no impact on Discovery. Multiple templates may be provided if there is data in multiple regions. At most one template must be specified per-region (including "global"). Each region is scanned using the applicable template. If no region-specific template is specified, but a "global" template is specified, it will be copied to that region and used instead. If no global or region-specific template is provided for a region with data, that region's data will not be scanned. For more information, see https://cloud.google.com/sensitive-data-protection/docs/data-profiles#data-residency.
lastRunTime	string (google-datetime)	Output only. The timestamp of the last time this config was executed.
orgConfig	object	Only set when the parent is an org. (id: GooglePrivacyDlpV2OrgConfig)
otherCloudStartingLocation	object	Must be set only when scanning other clouds. (id: GooglePrivacyDlpV2OtherCloudDiscoveryStartingLocation)
processingLocation	object	Optional. Processing location configuration. Vertex AI dataset scanning will set processing_location.image_fallback_type to MultiRegionProcessing by default. (id: GooglePrivacyDlpV2ProcessingLocation)
status	string	Required. A status for this configuration.
targets	array	Target to match against for determining what to scan and how frequently.
updateTime	string (google-datetime)	Output only. The last update timestamp of a DiscoveryConfig.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
projects_locations_discovery_configs_get	select	projectsId, locationsId, discoveryConfigsId		Gets a discovery configuration.
organizations_locations_discovery_configs_get	select	organizationsId, locationsId, discoveryConfigsId		Gets a discovery configuration.
projects_locations_discovery_configs_list	select	projectsId, locationsId	pageToken, pageSize, orderBy	Lists discovery configurations.
organizations_locations_discovery_configs_list	select	organizationsId, locationsId	pageToken, pageSize, orderBy	Lists discovery configurations.
projects_locations_discovery_configs_create	insert	projectsId, locationsId		Creates a config for discovery to scan and profile storage.
organizations_locations_discovery_configs_create	insert	organizationsId, locationsId		Creates a config for discovery to scan and profile storage.
projects_locations_discovery_configs_patch	update	projectsId, locationsId, discoveryConfigsId		Updates a discovery configuration.
organizations_locations_discovery_configs_patch	update	organizationsId, locationsId, discoveryConfigsId		Updates a discovery configuration.
projects_locations_discovery_configs_delete	delete	projectsId, locationsId, discoveryConfigsId		Deletes a discovery configuration.
organizations_locations_discovery_configs_delete	delete	organizationsId, locationsId, discoveryConfigsId		Deletes 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
discoveryConfigsId	string
locationsId	string
organizationsId	string
projectsId	string
orderBy	string
pageSize	integer (int32)
pageToken	string

SELECT examples

projects_locations_discovery_configs_get

Gets a discovery configuration.

SELECT
name,
actions,
createTime,
displayName,
errors,
inspectTemplates,
lastRunTime,
orgConfig,
otherCloudStartingLocation,
processingLocation,
status,
targets,
updateTime
FROM google.dlp.discovery_configs
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND discoveryConfigsId = '{{ discoveryConfigsId }}' -- required;

organizations_locations_discovery_configs_get

Gets a discovery configuration.

SELECT
name,
actions,
createTime,
displayName,
errors,
inspectTemplates,
lastRunTime,
orgConfig,
otherCloudStartingLocation,
processingLocation,
status,
targets,
updateTime
FROM google.dlp.discovery_configs
WHERE organizationsId = '{{ organizationsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND discoveryConfigsId = '{{ discoveryConfigsId }}' -- required;

projects_locations_discovery_configs_list

Lists discovery configurations.

SELECT
name,
actions,
createTime,
displayName,
errors,
inspectTemplates,
lastRunTime,
orgConfig,
otherCloudStartingLocation,
processingLocation,
status,
targets,
updateTime
FROM google.dlp.discovery_configs
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageToken = '{{ pageToken }}'
AND pageSize = '{{ pageSize }}'
AND orderBy = '{{ orderBy }}';

organizations_locations_discovery_configs_list

Lists discovery configurations.

SELECT
name,
actions,
createTime,
displayName,
errors,
inspectTemplates,
lastRunTime,
orgConfig,
otherCloudStartingLocation,
processingLocation,
status,
targets,
updateTime
FROM google.dlp.discovery_configs
WHERE organizationsId = '{{ organizationsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageToken = '{{ pageToken }}'
AND pageSize = '{{ pageSize }}'
AND orderBy = '{{ orderBy }}';

INSERT examples

projects_locations_discovery_configs_create

Creates a config for discovery to scan and profile storage.

INSERT INTO google.dlp.discovery_configs (
data__discoveryConfig,
data__configId,
projectsId,
locationsId
)
SELECT 
'{{ discoveryConfig }}',
'{{ configId }}',
'{{ projectsId }}',
'{{ locationsId }}'
RETURNING
name,
actions,
createTime,
displayName,
errors,
inspectTemplates,
lastRunTime,
orgConfig,
otherCloudStartingLocation,
processingLocation,
status,
targets,
updateTime
;

organizations_locations_discovery_configs_create

Creates a config for discovery to scan and profile storage.

INSERT INTO google.dlp.discovery_configs (
data__discoveryConfig,
data__configId,
organizationsId,
locationsId
)
SELECT 
'{{ discoveryConfig }}',
'{{ configId }}',
'{{ organizationsId }}',
'{{ locationsId }}'
RETURNING
name,
actions,
createTime,
displayName,
errors,
inspectTemplates,
lastRunTime,
orgConfig,
otherCloudStartingLocation,
processingLocation,
status,
targets,
updateTime
;

Manifest

# Description fields are for documentation purposes
- name: discovery_configs
  props:
    - name: projectsId
      value: string
      description: Required parameter for the discovery_configs resource.
    - name: locationsId
      value: string
      description: Required parameter for the discovery_configs resource.
    - name: organizationsId
      value: string
      description: Required parameter for the discovery_configs resource.
    - name: discoveryConfig
      value: object
      description: >
        Required. The DiscoveryConfig to create.
        
    - name: configId
      value: string
      description: >
        The config ID can contain uppercase and lowercase letters, numbers, and hyphens; that is, it must match the regular expression: `[a-zA-Z\d-_]+`. The maximum length is 100 characters. Can be empty to allow the system to generate one.
        

UPDATE examples

projects_locations_discovery_configs_patch

Updates a discovery configuration.

UPDATE google.dlp.discovery_configs
SET 
data__discoveryConfig = '{{ discoveryConfig }}',
data__updateMask = '{{ updateMask }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND discoveryConfigsId = '{{ discoveryConfigsId }}' --required
RETURNING
name,
actions,
createTime,
displayName,
errors,
inspectTemplates,
lastRunTime,
orgConfig,
otherCloudStartingLocation,
processingLocation,
status,
targets,
updateTime;

organizations_locations_discovery_configs_patch

Updates a discovery configuration.

UPDATE google.dlp.discovery_configs
SET 
data__discoveryConfig = '{{ discoveryConfig }}',
data__updateMask = '{{ updateMask }}'
WHERE 
organizationsId = '{{ organizationsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND discoveryConfigsId = '{{ discoveryConfigsId }}' --required
RETURNING
name,
actions,
createTime,
displayName,
errors,
inspectTemplates,
lastRunTime,
orgConfig,
otherCloudStartingLocation,
processingLocation,
status,
targets,
updateTime;

DELETE examples

projects_locations_discovery_configs_delete

Deletes a discovery configuration.

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

organizations_locations_discovery_configs_delete

Deletes a discovery configuration.

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