job_triggers

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

Overview

Name	job_triggers
Type	Resource
Id	google.dlp.job_triggers

Fields

The following fields are returned by SELECT queries:

projects_locations_job_triggers_get

Successful response

Name	Datatype	Description
name	string	Unique resource name for the triggeredJob, assigned by the service when the triggeredJob is created, for example projects/dlp-test-project/jobTriggers/53234423.
createTime	string (google-datetime)	Output only. The creation timestamp of a triggeredJob.
description	string	User provided description (max 256 chars)
displayName	string	Display name (max 100 chars)
errors	array	Output only. A stream of errors encountered when the trigger was activated. Repeated errors may result in the JobTrigger automatically being paused. Will return the last 100 errors. Whenever the JobTrigger is modified this list will be cleared.
inspectJob	object	For inspect jobs, a snapshot of the configuration. (id: GooglePrivacyDlpV2InspectJobConfig)
lastRunTime	string (google-datetime)	Output only. The timestamp of the last time this trigger executed.
status	string	Required. A status for this trigger.
triggers	array	A list of triggers which will be OR'ed together. Only one in the list needs to trigger for a job to be started. The list may contain only a single Schedule trigger and must have at least one object.
updateTime	string (google-datetime)	Output only. The last update timestamp of a triggeredJob.

organizations_locations_job_triggers_get

Successful response

Name	Datatype	Description
name	string	Unique resource name for the triggeredJob, assigned by the service when the triggeredJob is created, for example projects/dlp-test-project/jobTriggers/53234423.
createTime	string (google-datetime)	Output only. The creation timestamp of a triggeredJob.
description	string	User provided description (max 256 chars)
displayName	string	Display name (max 100 chars)
errors	array	Output only. A stream of errors encountered when the trigger was activated. Repeated errors may result in the JobTrigger automatically being paused. Will return the last 100 errors. Whenever the JobTrigger is modified this list will be cleared.
inspectJob	object	For inspect jobs, a snapshot of the configuration. (id: GooglePrivacyDlpV2InspectJobConfig)
lastRunTime	string (google-datetime)	Output only. The timestamp of the last time this trigger executed.
status	string	Required. A status for this trigger.
triggers	array	A list of triggers which will be OR'ed together. Only one in the list needs to trigger for a job to be started. The list may contain only a single Schedule trigger and must have at least one object.
updateTime	string (google-datetime)	Output only. The last update timestamp of a triggeredJob.

projects_locations_job_triggers_list

Successful response

Name	Datatype	Description
name	string	Unique resource name for the triggeredJob, assigned by the service when the triggeredJob is created, for example projects/dlp-test-project/jobTriggers/53234423.
createTime	string (google-datetime)	Output only. The creation timestamp of a triggeredJob.
description	string	User provided description (max 256 chars)
displayName	string	Display name (max 100 chars)
errors	array	Output only. A stream of errors encountered when the trigger was activated. Repeated errors may result in the JobTrigger automatically being paused. Will return the last 100 errors. Whenever the JobTrigger is modified this list will be cleared.
inspectJob	object	For inspect jobs, a snapshot of the configuration. (id: GooglePrivacyDlpV2InspectJobConfig)
lastRunTime	string (google-datetime)	Output only. The timestamp of the last time this trigger executed.
status	string	Required. A status for this trigger.
triggers	array	A list of triggers which will be OR'ed together. Only one in the list needs to trigger for a job to be started. The list may contain only a single Schedule trigger and must have at least one object.
updateTime	string (google-datetime)	Output only. The last update timestamp of a triggeredJob.

projects_job_triggers_get

Successful response

Name	Datatype	Description
name	string	Unique resource name for the triggeredJob, assigned by the service when the triggeredJob is created, for example projects/dlp-test-project/jobTriggers/53234423.
createTime	string (google-datetime)	Output only. The creation timestamp of a triggeredJob.
description	string	User provided description (max 256 chars)
displayName	string	Display name (max 100 chars)
errors	array	Output only. A stream of errors encountered when the trigger was activated. Repeated errors may result in the JobTrigger automatically being paused. Will return the last 100 errors. Whenever the JobTrigger is modified this list will be cleared.
inspectJob	object	For inspect jobs, a snapshot of the configuration. (id: GooglePrivacyDlpV2InspectJobConfig)
lastRunTime	string (google-datetime)	Output only. The timestamp of the last time this trigger executed.
status	string	Required. A status for this trigger.
triggers	array	A list of triggers which will be OR'ed together. Only one in the list needs to trigger for a job to be started. The list may contain only a single Schedule trigger and must have at least one object.
updateTime	string (google-datetime)	Output only. The last update timestamp of a triggeredJob.

organizations_locations_job_triggers_list

Successful response

Name	Datatype	Description
name	string	Unique resource name for the triggeredJob, assigned by the service when the triggeredJob is created, for example projects/dlp-test-project/jobTriggers/53234423.
createTime	string (google-datetime)	Output only. The creation timestamp of a triggeredJob.
description	string	User provided description (max 256 chars)
displayName	string	Display name (max 100 chars)
errors	array	Output only. A stream of errors encountered when the trigger was activated. Repeated errors may result in the JobTrigger automatically being paused. Will return the last 100 errors. Whenever the JobTrigger is modified this list will be cleared.
inspectJob	object	For inspect jobs, a snapshot of the configuration. (id: GooglePrivacyDlpV2InspectJobConfig)
lastRunTime	string (google-datetime)	Output only. The timestamp of the last time this trigger executed.
status	string	Required. A status for this trigger.
triggers	array	A list of triggers which will be OR'ed together. Only one in the list needs to trigger for a job to be started. The list may contain only a single Schedule trigger and must have at least one object.
updateTime	string (google-datetime)	Output only. The last update timestamp of a triggeredJob.

projects_job_triggers_list

Successful response

Name	Datatype	Description
name	string	Unique resource name for the triggeredJob, assigned by the service when the triggeredJob is created, for example projects/dlp-test-project/jobTriggers/53234423.
createTime	string (google-datetime)	Output only. The creation timestamp of a triggeredJob.
description	string	User provided description (max 256 chars)
displayName	string	Display name (max 100 chars)
errors	array	Output only. A stream of errors encountered when the trigger was activated. Repeated errors may result in the JobTrigger automatically being paused. Will return the last 100 errors. Whenever the JobTrigger is modified this list will be cleared.
inspectJob	object	For inspect jobs, a snapshot of the configuration. (id: GooglePrivacyDlpV2InspectJobConfig)
lastRunTime	string (google-datetime)	Output only. The timestamp of the last time this trigger executed.
status	string	Required. A status for this trigger.
triggers	array	A list of triggers which will be OR'ed together. Only one in the list needs to trigger for a job to be started. The list may contain only a single Schedule trigger and must have at least one object.
updateTime	string (google-datetime)	Output only. The last update timestamp of a triggeredJob.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
projects_locations_job_triggers_get	select	projectsId, locationsId, jobTriggersId		Gets a job trigger. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.
organizations_locations_job_triggers_get	select	organizationsId, locationsId, jobTriggersId		Gets a job trigger. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.
projects_locations_job_triggers_list	select	projectsId, locationsId	pageToken, pageSize, orderBy, filter, type, locationId	Lists job triggers. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.
projects_job_triggers_get	select	projectsId, jobTriggersId		Gets a job trigger. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.
organizations_locations_job_triggers_list	select	organizationsId, locationsId	pageToken, pageSize, orderBy, filter, type, locationId	Lists job triggers. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.
projects_job_triggers_list	select	projectsId	pageToken, pageSize, orderBy, filter, type, locationId	Lists job triggers. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.
projects_locations_job_triggers_create	insert	projectsId, locationsId		Creates a job trigger to run DLP actions such as scanning storage for sensitive information on a set schedule. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.
organizations_locations_job_triggers_create	insert	organizationsId, locationsId		Creates a job trigger to run DLP actions such as scanning storage for sensitive information on a set schedule. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.
projects_job_triggers_create	insert	projectsId		Creates a job trigger to run DLP actions such as scanning storage for sensitive information on a set schedule. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.
projects_locations_job_triggers_patch	update	projectsId, locationsId, jobTriggersId		Updates a job trigger. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.
organizations_locations_job_triggers_patch	update	organizationsId, locationsId, jobTriggersId		Updates a job trigger. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.
projects_job_triggers_patch	update	projectsId, jobTriggersId		Updates a job trigger. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.
projects_locations_job_triggers_delete	delete	projectsId, locationsId, jobTriggersId		Deletes a job trigger. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.
organizations_locations_job_triggers_delete	delete	organizationsId, locationsId, jobTriggersId		Deletes a job trigger. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.
projects_job_triggers_delete	delete	projectsId, jobTriggersId		Deletes a job trigger. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.
projects_locations_job_triggers_hybrid_inspect	exec	projectsId, locationsId, jobTriggersId		Inspect hybrid content and store findings to a trigger. The inspection will be processed asynchronously. To review the findings monitor the jobs within the trigger.
projects_locations_job_triggers_activate	exec	projectsId, locationsId, jobTriggersId		Activate a job trigger. Causes the immediate execute of a trigger instead of waiting on the trigger event to occur.
projects_job_triggers_activate	exec	projectsId, jobTriggersId		Activate a job trigger. Causes the immediate execute of a trigger instead of waiting on the trigger event to occur.

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
jobTriggersId	string
locationsId	string
organizationsId	string
projectsId	string
filter	string
locationId	string
orderBy	string
pageSize	integer (int32)
pageToken	string
type	string

SELECT examples

projects_locations_job_triggers_get

Gets a job trigger. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.

SELECT
name,
createTime,
description,
displayName,
errors,
inspectJob,
lastRunTime,
status,
triggers,
updateTime
FROM google.dlp.job_triggers
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND jobTriggersId = '{{ jobTriggersId }}' -- required;

organizations_locations_job_triggers_get

Gets a job trigger. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.

SELECT
name,
createTime,
description,
displayName,
errors,
inspectJob,
lastRunTime,
status,
triggers,
updateTime
FROM google.dlp.job_triggers
WHERE organizationsId = '{{ organizationsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND jobTriggersId = '{{ jobTriggersId }}' -- required;

projects_locations_job_triggers_list

Lists job triggers. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.

SELECT
name,
createTime,
description,
displayName,
errors,
inspectJob,
lastRunTime,
status,
triggers,
updateTime
FROM google.dlp.job_triggers
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageToken = '{{ pageToken }}'
AND pageSize = '{{ pageSize }}'
AND orderBy = '{{ orderBy }}'
AND filter = '{{ filter }}'
AND type = '{{ type }}'
AND locationId = '{{ locationId }}';

projects_job_triggers_get

Gets a job trigger. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.

SELECT
name,
createTime,
description,
displayName,
errors,
inspectJob,
lastRunTime,
status,
triggers,
updateTime
FROM google.dlp.job_triggers
WHERE projectsId = '{{ projectsId }}' -- required
AND jobTriggersId = '{{ jobTriggersId }}' -- required;

organizations_locations_job_triggers_list

Lists job triggers. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.

SELECT
name,
createTime,
description,
displayName,
errors,
inspectJob,
lastRunTime,
status,
triggers,
updateTime
FROM google.dlp.job_triggers
WHERE organizationsId = '{{ organizationsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageToken = '{{ pageToken }}'
AND pageSize = '{{ pageSize }}'
AND orderBy = '{{ orderBy }}'
AND filter = '{{ filter }}'
AND type = '{{ type }}'
AND locationId = '{{ locationId }}';

projects_job_triggers_list

Lists job triggers. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.

SELECT
name,
createTime,
description,
displayName,
errors,
inspectJob,
lastRunTime,
status,
triggers,
updateTime
FROM google.dlp.job_triggers
WHERE projectsId = '{{ projectsId }}' -- required
AND pageToken = '{{ pageToken }}'
AND pageSize = '{{ pageSize }}'
AND orderBy = '{{ orderBy }}'
AND filter = '{{ filter }}'
AND type = '{{ type }}'
AND locationId = '{{ locationId }}';

INSERT examples

projects_locations_job_triggers_create

Creates a job trigger to run DLP actions such as scanning storage for sensitive information on a set schedule. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.

INSERT INTO google.dlp.job_triggers (
data__jobTrigger,
data__triggerId,
data__locationId,
projectsId,
locationsId
)
SELECT 
'{{ jobTrigger }}',
'{{ triggerId }}',
'{{ locationId }}',
'{{ projectsId }}',
'{{ locationsId }}'
RETURNING
name,
createTime,
description,
displayName,
errors,
inspectJob,
lastRunTime,
status,
triggers,
updateTime
;

organizations_locations_job_triggers_create

Creates a job trigger to run DLP actions such as scanning storage for sensitive information on a set schedule. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.

INSERT INTO google.dlp.job_triggers (
data__jobTrigger,
data__triggerId,
data__locationId,
organizationsId,
locationsId
)
SELECT 
'{{ jobTrigger }}',
'{{ triggerId }}',
'{{ locationId }}',
'{{ organizationsId }}',
'{{ locationsId }}'
RETURNING
name,
createTime,
description,
displayName,
errors,
inspectJob,
lastRunTime,
status,
triggers,
updateTime
;

projects_job_triggers_create

Creates a job trigger to run DLP actions such as scanning storage for sensitive information on a set schedule. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.

INSERT INTO google.dlp.job_triggers (
data__jobTrigger,
data__triggerId,
data__locationId,
projectsId
)
SELECT 
'{{ jobTrigger }}',
'{{ triggerId }}',
'{{ locationId }}',
'{{ projectsId }}'
RETURNING
name,
createTime,
description,
displayName,
errors,
inspectJob,
lastRunTime,
status,
triggers,
updateTime
;

Manifest

# Description fields are for documentation purposes
- name: job_triggers
  props:
    - name: projectsId
      value: string
      description: Required parameter for the job_triggers resource.
    - name: locationsId
      value: string
      description: Required parameter for the job_triggers resource.
    - name: organizationsId
      value: string
      description: Required parameter for the job_triggers resource.
    - name: jobTrigger
      value: object
      description: >
        Required. The JobTrigger to create.
        
    - name: triggerId
      value: string
      description: >
        The trigger 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.
        
    - name: locationId
      value: string
      description: >
        Deprecated. This field has no effect.
        

UPDATE examples

projects_locations_job_triggers_patch

Updates a job trigger. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.

UPDATE google.dlp.job_triggers
SET 
data__jobTrigger = '{{ jobTrigger }}',
data__updateMask = '{{ updateMask }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND jobTriggersId = '{{ jobTriggersId }}' --required
RETURNING
name,
createTime,
description,
displayName,
errors,
inspectJob,
lastRunTime,
status,
triggers,
updateTime;

organizations_locations_job_triggers_patch

Updates a job trigger. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.

UPDATE google.dlp.job_triggers
SET 
data__jobTrigger = '{{ jobTrigger }}',
data__updateMask = '{{ updateMask }}'
WHERE 
organizationsId = '{{ organizationsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND jobTriggersId = '{{ jobTriggersId }}' --required
RETURNING
name,
createTime,
description,
displayName,
errors,
inspectJob,
lastRunTime,
status,
triggers,
updateTime;

projects_job_triggers_patch

Updates a job trigger. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.

UPDATE google.dlp.job_triggers
SET 
data__jobTrigger = '{{ jobTrigger }}',
data__updateMask = '{{ updateMask }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND jobTriggersId = '{{ jobTriggersId }}' --required
RETURNING
name,
createTime,
description,
displayName,
errors,
inspectJob,
lastRunTime,
status,
triggers,
updateTime;

DELETE examples

projects_locations_job_triggers_delete

Deletes a job trigger. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.

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

organizations_locations_job_triggers_delete

Deletes a job trigger. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.

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

projects_job_triggers_delete

Deletes a job trigger. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.

DELETE FROM google.dlp.job_triggers
WHERE projectsId = '{{ projectsId }}' --required
AND jobTriggersId = '{{ jobTriggersId }}' --required;

Lifecycle Methods

projects_locations_job_triggers_hybrid_inspect

Inspect hybrid content and store findings to a trigger. The inspection will be processed asynchronously. To review the findings monitor the jobs within the trigger.

EXEC google.dlp.job_triggers.projects_locations_job_triggers_hybrid_inspect 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@jobTriggersId='{{ jobTriggersId }}' --required 
@@json=
'{
"hybridItem": "{{ hybridItem }}"
}';

projects_locations_job_triggers_activate

Activate a job trigger. Causes the immediate execute of a trigger instead of waiting on the trigger event to occur.

EXEC google.dlp.job_triggers.projects_locations_job_triggers_activate 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@jobTriggersId='{{ jobTriggersId }}' --required;

projects_job_triggers_activate

Activate a job trigger. Causes the immediate execute of a trigger instead of waiting on the trigger event to occur.

EXEC google.dlp.job_triggers.projects_job_triggers_activate 
@projectsId='{{ projectsId }}' --required, 
@jobTriggersId='{{ jobTriggersId }}' --required;