name STRING Required

Resource name of the project and the triggeredJob, for example projects/dlp-test-project/jobTriggers/53234423

createTime ANY

The creation timestamp of a triggeredJob, output only field

status ENUMERATION

A status for this trigger. [required]

inspectJob OBJECT

inspectJob.inspectConfig OBJECT

Configuration description of the scanning process. When used with redactContent only info_types and min_likelihood are currently used

inspectJob.inspectConfig.contentOptions[] ENUMERATION

inspectJob.inspectConfig.limits OBJECT

inspectJob.inspectConfig.limits.maxFindingsPerItem INTEGER

Max number of findings that will be returned for each item scanned. When set within InspectDataSourceRequest, the maximum returned is 2000 regardless if this is set higher. When set within InspectContentRequest, this field is ignored

inspectJob.inspectConfig.limits.maxFindingsPerRequest INTEGER

Max number of findings that will be returned per request/job. When set within InspectContentRequest, the maximum returned is 2000 regardless if this is set higher

inspectJob.inspectConfig.excludeInfoTypes BOOLEAN

When true, excludes type information of the findings

inspectJob.inspectConfig.minLikelihood ENUMERATION

Only returns findings equal or above this threshold. The default is POSSIBLE. See https://cloud.google.com/dlp/docs/likelihood to learn more

inspectJob.inspectConfig.ruleSet[] OBJECT

Rule set for modifying a set of infoTypes to alter behavior under certain circumstances, depending on the specific details of the rules within the set

inspectJob.inspectConfig.infoTypes[] OBJECT

Type of information detected by the API

inspectJob.inspectConfig.infoTypes[].name STRING

Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/dlp/docs/infotypes-reference when specifying a built-in type. InfoType names should conform to the pattern [a-zA-Z0-9_]{1,64}

inspectJob.inspectConfig.includeQuote BOOLEAN

When true, a contextual quote from the data that triggered a finding is included in the response; see Finding.quote

inspectJob.inspectConfig.customInfoTypes[] OBJECT

Custom information type provided by the user. Used to find domain-specific sensitive information configurable to the data in question

inspectJob.inspectConfig.customInfoTypes[].likelihood ENUMERATION

Likelihood to return for this CustomInfoType. This base value can be altered by a detection rule if the finding meets the criteria specified by the rule. Defaults to VERY_LIKELY if not specified

inspectJob.inspectConfig.customInfoTypes[].exclusionType ENUMERATION

If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching

inspectJob.inspectTemplateName STRING

If provided, will be used as the default for all values in InspectConfig. inspect_config will be merged into the values persisted as part of the template

inspectJob.storageConfig OBJECT

Shared message indicating Cloud storage type

inspectJob.storageConfig.datastoreOptions OBJECT

Options defining a data set within Google Cloud Datastore

inspectJob.storageConfig.datastoreOptions.partitionId OBJECT

Datastore partition ID. A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty.

A partition ID contains several dimensions: project ID and namespace ID

inspectJob.storageConfig.datastoreOptions.kind OBJECT

A representation of a Datastore kind

inspectJob.storageConfig.timespanConfig OBJECT

Configuration of the timespan of the items to include in scanning. Currently only supported when inspecting Google Cloud Storage and BigQuery

inspectJob.storageConfig.timespanConfig.startTime ANY

Exclude files or rows older than this value

inspectJob.storageConfig.timespanConfig.timestampField OBJECT

General identifier of a data field in a storage service

inspectJob.storageConfig.timespanConfig.endTime ANY

Exclude files or rows newer than this value. If set to zero, no upper time limit is applied

inspectJob.storageConfig.timespanConfig.enableAutoPopulationOfTimespanConfig BOOLEAN

When the job is started by a JobTrigger we will automatically figure out a valid start_time to avoid scanning files that have not been modified since the last time the JobTrigger executed. This will be based on the time of the execution of the last run of the JobTrigger

inspectJob.storageConfig.bigQueryOptions OBJECT

Options defining BigQuery table and row identifiers

inspectJob.storageConfig.bigQueryOptions.tableReference OBJECT

Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: <project_id>:<dataset_id>.<table_id> or <project_id>.<dataset_id>.<table_id>

inspectJob.storageConfig.bigQueryOptions.sampleMethod ENUMERATION

inspectJob.storageConfig.bigQueryOptions.rowsLimit INTEGER

Max number of rows to scan. If the table has more rows than this value, the rest of the rows are omitted. If not set, or if set to 0, all rows will be scanned. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig

inspectJob.storageConfig.bigQueryOptions.rowsLimitPercent INTEGER

Max percentage of rows to scan. The rest are omitted. The number of rows scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig

inspectJob.storageConfig.cloudStorageOptions OBJECT

Options defining a file or a set of files within a Google Cloud Storage bucket

inspectJob.storageConfig.cloudStorageOptions.bytesLimitPerFile INTEGER

Max number of bytes to scan from a file. If a scanned file's size is bigger than this value then the rest of the bytes are omitted. Only one of bytes_limit_per_file and bytes_limit_per_file_percent can be specified

inspectJob.storageConfig.cloudStorageOptions.filesLimitPercent INTEGER

Limits the number of files to scan to this percentage of the input FileSet. Number of files scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0

inspectJob.storageConfig.cloudStorageOptions.fileSet OBJECT

Set of files to scan

inspectJob.storageConfig.cloudStorageOptions.sampleMethod ENUMERATION

inspectJob.storageConfig.cloudStorageOptions.bytesLimitPerFilePercent INTEGER

Max percentage of bytes to scan from a file. The rest are omitted. The number of bytes scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of bytes_limit_per_file and bytes_limit_per_file_percent can be specified

inspectJob.storageConfig.cloudStorageOptions.fileTypes[] ENUMERATION

inspectJob.actions[] OBJECT

A task to execute on the completion of a job. See https://cloud.google.com/dlp/docs/concepts-actions to learn more

inspectJob.actions[].jobNotificationEmails OBJECT

Enable email notification to project owners and editors on jobs's completion/failure

inspectJob.actions[].saveFindings OBJECT

If set, the detailed findings will be persisted to the specified OutputStorageConfig. Only a single instance of this action can be specified. Compatible with: Inspect, Risk

inspectJob.actions[].pubSub OBJECT

Publish a message into given Pub/Sub topic when DlpJob has completed. The message contains a single field, DlpJobName, which is equal to the finished job's DlpJob.name. Compatible with: Inspect, Risk

inspectJob.actions[].pubSub.topic STRING

Cloud Pub/Sub topic to send notifications to. The topic must have given publishing access rights to the DLP API service account executing the long running DlpJob sending the notifications. Format is projects/{project}/topics/{topic}

inspectJob.actions[].publishSummaryToCscc OBJECT

Publish the result summary of a DlpJob to the Cloud Security Command Center (CSCC Alpha). This action is only available for projects which are parts of an organization and whitelisted for the alpha Cloud Security Command Center. The action will publish count of finding instances and their info types. The summary of findings will be persisted in CSCC and are governed by CSCC service-specific policy, see https://cloud.google.com/terms/service-terms Only a single instance of this action can be specified. Compatible with: Inspect

updateTime ANY

The last update timestamp of a triggeredJob, output only field

name STRING

Unique resource name for the triggeredJob, assigned by the service when the triggeredJob is created, for example projects/dlp-test-project/triggeredJobs/53234423

triggers[] OBJECT

What event needs to occur for a new job to be started

triggers[].schedule OBJECT

Schedule for triggeredJobs

triggers[].schedule.recurrencePeriodDuration ANY

With this option a job is started a regular periodic basis. For example: every day (86400 seconds).

A scheduled start time will be skipped if the previous execution has not ended when its scheduled time occurs.

This value must be set to a time duration greater than or equal to 1 day and can be no longer than 60 days

errors[] OBJECT

Details information about an error encountered during job execution or the results of an unsuccessful activation of the JobTrigger. Output only field

errors[].timestamps[] ANY

errors[].details OBJECT

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details.

You can find out more about this error model and how to work with it in the API Design Guide

errors[].details.details[] OBJECT

errors[].details.details[].customKey.value ANY

errors[].details.code INTEGER

The status code, which should be an enum value of google.rpc.Code

errors[].details.message STRING

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client

lastRunTime ANY

The timestamp of the last time this trigger executed, output only field

displayName STRING

Display name (max 100 chars)

description STRING

User provided description (max 256 chars)