REST Resource: projects.locations.discoveryConfigs

Resource: DiscoveryConfig

Configuration for discovery to scan resources for profile generation. Only one discovery configuration may exist per organization, folder, or project.

The generated data profiles are retained according to the data retention policy.

JSON representation
{
  "name": string,
  "displayName": string,
  "orgConfig": {
    object (OrgConfig)
  },
  "otherCloudStartingLocation": {
    object (OtherCloudDiscoveryStartingLocation)
  },
  "inspectTemplates": [
    string
  ],
  "actions": [
    {
      object (DataProfileAction)
    }
  ],
  "targets": [
    {
      object (DiscoveryTarget)
    }
  ],
  "errors": [
    {
      object (Error)
    }
  ],
  "createTime": string,
  "updateTime": string,
  "lastRunTime": string,
  "status": enum (Status)
}
Fields
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.

displayName

string

Display name (max 100 chars)

orgConfig

object (OrgConfig)

Only set when the parent is an org.

otherCloudStartingLocation

object (OtherCloudDiscoveryStartingLocation)

Must be set only when scanning other clouds.

inspectTemplates[]

string

Detection logic for profile generation.

Not all template features are used by Discovery. FindingLimits, includeQuote and excludeInfoTypes 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.

actions[]

object (DataProfileAction)

Actions to execute at the completion of scanning.

targets[]

object (DiscoveryTarget)

Target to match against for determining what to scan and how frequently.

errors[]

object (Error)

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.

createTime

string (Timestamp format)

Output only. The creation timestamp of a DiscoveryConfig.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

updateTime

string (Timestamp format)

Output only. The last update timestamp of a DiscoveryConfig.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

lastRunTime

string (Timestamp format)

Output only. The timestamp of the last time this config was executed.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

status

enum (Status)

Required. A status for this configuration.

Methods

create

Creates a config for discovery to scan and profile storage.

delete

Deletes a discovery configuration.

get

Gets a discovery configuration.

list

Lists discovery configurations.

patch

Updates a discovery configuration.