inspect_templates

Creates, updates, deletes, gets or lists an inspect_templates resource.

Overview

Name	inspect_templates
Type	Resource
Id	google.dlp.inspect_templates

Fields

The following fields are returned by SELECT queries:

projects_locations_inspect_templates_get

Successful response

Name	Datatype	Description
name	string	Output only. The template name. The template will have one of the following formats: projects/PROJECT_ID/inspectTemplates/TEMPLATE_ID OR organizations/ORGANIZATION_ID/inspectTemplates/TEMPLATE_ID;
createTime	string (google-datetime)	Output only. The creation timestamp of an inspectTemplate.
description	string	Short description (max 256 chars).
displayName	string	Display name (max 256 chars).
inspectConfig	object	The core content of the template. Configuration of the scanning process. (id: GooglePrivacyDlpV2InspectConfig)
updateTime	string (google-datetime)	Output only. The last update timestamp of an inspectTemplate.

organizations_locations_inspect_templates_get

Successful response

Name	Datatype	Description
name	string	Output only. The template name. The template will have one of the following formats: projects/PROJECT_ID/inspectTemplates/TEMPLATE_ID OR organizations/ORGANIZATION_ID/inspectTemplates/TEMPLATE_ID;
createTime	string (google-datetime)	Output only. The creation timestamp of an inspectTemplate.
description	string	Short description (max 256 chars).
displayName	string	Display name (max 256 chars).
inspectConfig	object	The core content of the template. Configuration of the scanning process. (id: GooglePrivacyDlpV2InspectConfig)
updateTime	string (google-datetime)	Output only. The last update timestamp of an inspectTemplate.

projects_locations_inspect_templates_list

Successful response

Name	Datatype	Description
name	string	Output only. The template name. The template will have one of the following formats: projects/PROJECT_ID/inspectTemplates/TEMPLATE_ID OR organizations/ORGANIZATION_ID/inspectTemplates/TEMPLATE_ID;
createTime	string (google-datetime)	Output only. The creation timestamp of an inspectTemplate.
description	string	Short description (max 256 chars).
displayName	string	Display name (max 256 chars).
inspectConfig	object	The core content of the template. Configuration of the scanning process. (id: GooglePrivacyDlpV2InspectConfig)
updateTime	string (google-datetime)	Output only. The last update timestamp of an inspectTemplate.

projects_inspect_templates_get

Successful response

Name	Datatype	Description
name	string	Output only. The template name. The template will have one of the following formats: projects/PROJECT_ID/inspectTemplates/TEMPLATE_ID OR organizations/ORGANIZATION_ID/inspectTemplates/TEMPLATE_ID;
createTime	string (google-datetime)	Output only. The creation timestamp of an inspectTemplate.
description	string	Short description (max 256 chars).
displayName	string	Display name (max 256 chars).
inspectConfig	object	The core content of the template. Configuration of the scanning process. (id: GooglePrivacyDlpV2InspectConfig)
updateTime	string (google-datetime)	Output only. The last update timestamp of an inspectTemplate.

organizations_locations_inspect_templates_list

Successful response

Name	Datatype	Description
name	string	Output only. The template name. The template will have one of the following formats: projects/PROJECT_ID/inspectTemplates/TEMPLATE_ID OR organizations/ORGANIZATION_ID/inspectTemplates/TEMPLATE_ID;
createTime	string (google-datetime)	Output only. The creation timestamp of an inspectTemplate.
description	string	Short description (max 256 chars).
displayName	string	Display name (max 256 chars).
inspectConfig	object	The core content of the template. Configuration of the scanning process. (id: GooglePrivacyDlpV2InspectConfig)
updateTime	string (google-datetime)	Output only. The last update timestamp of an inspectTemplate.

organizations_inspect_templates_get

Successful response

Name	Datatype	Description
name	string	Output only. The template name. The template will have one of the following formats: projects/PROJECT_ID/inspectTemplates/TEMPLATE_ID OR organizations/ORGANIZATION_ID/inspectTemplates/TEMPLATE_ID;
createTime	string (google-datetime)	Output only. The creation timestamp of an inspectTemplate.
description	string	Short description (max 256 chars).
displayName	string	Display name (max 256 chars).
inspectConfig	object	The core content of the template. Configuration of the scanning process. (id: GooglePrivacyDlpV2InspectConfig)
updateTime	string (google-datetime)	Output only. The last update timestamp of an inspectTemplate.

projects_inspect_templates_list

Successful response

Name	Datatype	Description
name	string	Output only. The template name. The template will have one of the following formats: projects/PROJECT_ID/inspectTemplates/TEMPLATE_ID OR organizations/ORGANIZATION_ID/inspectTemplates/TEMPLATE_ID;
createTime	string (google-datetime)	Output only. The creation timestamp of an inspectTemplate.
description	string	Short description (max 256 chars).
displayName	string	Display name (max 256 chars).
inspectConfig	object	The core content of the template. Configuration of the scanning process. (id: GooglePrivacyDlpV2InspectConfig)
updateTime	string (google-datetime)	Output only. The last update timestamp of an inspectTemplate.

organizations_inspect_templates_list

Successful response

Name	Datatype	Description
name	string	Output only. The template name. The template will have one of the following formats: projects/PROJECT_ID/inspectTemplates/TEMPLATE_ID OR organizations/ORGANIZATION_ID/inspectTemplates/TEMPLATE_ID;
createTime	string (google-datetime)	Output only. The creation timestamp of an inspectTemplate.
description	string	Short description (max 256 chars).
displayName	string	Display name (max 256 chars).
inspectConfig	object	The core content of the template. Configuration of the scanning process. (id: GooglePrivacyDlpV2InspectConfig)
updateTime	string (google-datetime)	Output only. The last update timestamp of an inspectTemplate.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
projects_locations_inspect_templates_get	select	projectsId, locationsId, inspectTemplatesId		Gets an InspectTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.
organizations_locations_inspect_templates_get	select	organizationsId, locationsId, inspectTemplatesId		Gets an InspectTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.
projects_locations_inspect_templates_list	select	projectsId, locationsId	pageToken, pageSize, orderBy, locationId	Lists InspectTemplates. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.
projects_inspect_templates_get	select	projectsId, inspectTemplatesId		Gets an InspectTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.
organizations_locations_inspect_templates_list	select	organizationsId, locationsId	pageToken, pageSize, orderBy, locationId	Lists InspectTemplates. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.
organizations_inspect_templates_get	select	organizationsId, inspectTemplatesId		Gets an InspectTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.
projects_inspect_templates_list	select	projectsId	pageToken, pageSize, orderBy, locationId	Lists InspectTemplates. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.
organizations_inspect_templates_list	select	organizationsId	pageToken, pageSize, orderBy, locationId	Lists InspectTemplates. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.
projects_locations_inspect_templates_create	insert	projectsId, locationsId		Creates an InspectTemplate for reusing frequently used configuration for inspecting content, images, and storage. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.
organizations_locations_inspect_templates_create	insert	organizationsId, locationsId		Creates an InspectTemplate for reusing frequently used configuration for inspecting content, images, and storage. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.
projects_inspect_templates_create	insert	projectsId		Creates an InspectTemplate for reusing frequently used configuration for inspecting content, images, and storage. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.
organizations_inspect_templates_create	insert	organizationsId		Creates an InspectTemplate for reusing frequently used configuration for inspecting content, images, and storage. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.
projects_locations_inspect_templates_patch	update	projectsId, locationsId, inspectTemplatesId		Updates the InspectTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.
organizations_locations_inspect_templates_patch	update	organizationsId, locationsId, inspectTemplatesId		Updates the InspectTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.
projects_inspect_templates_patch	update	projectsId, inspectTemplatesId		Updates the InspectTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.
organizations_inspect_templates_patch	update	organizationsId, inspectTemplatesId		Updates the InspectTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.
projects_locations_inspect_templates_delete	delete	projectsId, locationsId, inspectTemplatesId		Deletes an InspectTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.
organizations_locations_inspect_templates_delete	delete	organizationsId, locationsId, inspectTemplatesId		Deletes an InspectTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.
projects_inspect_templates_delete	delete	projectsId, inspectTemplatesId		Deletes an InspectTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.
organizations_inspect_templates_delete	delete	organizationsId, inspectTemplatesId		Deletes an InspectTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.

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

SELECT examples

projects_locations_inspect_templates_get

Gets an InspectTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.

SELECT
name,
createTime,
description,
displayName,
inspectConfig,
updateTime
FROM google.dlp.inspect_templates
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND inspectTemplatesId = '{{ inspectTemplatesId }}' -- required;

organizations_locations_inspect_templates_get

Gets an InspectTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.

SELECT
name,
createTime,
description,
displayName,
inspectConfig,
updateTime
FROM google.dlp.inspect_templates
WHERE organizationsId = '{{ organizationsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND inspectTemplatesId = '{{ inspectTemplatesId }}' -- required;

projects_locations_inspect_templates_list

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

SELECT
name,
createTime,
description,
displayName,
inspectConfig,
updateTime
FROM google.dlp.inspect_templates
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageToken = '{{ pageToken }}'
AND pageSize = '{{ pageSize }}'
AND orderBy = '{{ orderBy }}'
AND locationId = '{{ locationId }}';

projects_inspect_templates_get

Gets an InspectTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.

SELECT
name,
createTime,
description,
displayName,
inspectConfig,
updateTime
FROM google.dlp.inspect_templates
WHERE projectsId = '{{ projectsId }}' -- required
AND inspectTemplatesId = '{{ inspectTemplatesId }}' -- required;

organizations_locations_inspect_templates_list

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

SELECT
name,
createTime,
description,
displayName,
inspectConfig,
updateTime
FROM google.dlp.inspect_templates
WHERE organizationsId = '{{ organizationsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageToken = '{{ pageToken }}'
AND pageSize = '{{ pageSize }}'
AND orderBy = '{{ orderBy }}'
AND locationId = '{{ locationId }}';

organizations_inspect_templates_get

Gets an InspectTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.

SELECT
name,
createTime,
description,
displayName,
inspectConfig,
updateTime
FROM google.dlp.inspect_templates
WHERE organizationsId = '{{ organizationsId }}' -- required
AND inspectTemplatesId = '{{ inspectTemplatesId }}' -- required;

projects_inspect_templates_list

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

SELECT
name,
createTime,
description,
displayName,
inspectConfig,
updateTime
FROM google.dlp.inspect_templates
WHERE projectsId = '{{ projectsId }}' -- required
AND pageToken = '{{ pageToken }}'
AND pageSize = '{{ pageSize }}'
AND orderBy = '{{ orderBy }}'
AND locationId = '{{ locationId }}';

organizations_inspect_templates_list

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

SELECT
name,
createTime,
description,
displayName,
inspectConfig,
updateTime
FROM google.dlp.inspect_templates
WHERE organizationsId = '{{ organizationsId }}' -- required
AND pageToken = '{{ pageToken }}'
AND pageSize = '{{ pageSize }}'
AND orderBy = '{{ orderBy }}'
AND locationId = '{{ locationId }}';

INSERT examples

projects_locations_inspect_templates_create

Creates an InspectTemplate for reusing frequently used configuration for inspecting content, images, and storage. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.

INSERT INTO google.dlp.inspect_templates (
data__inspectTemplate,
data__templateId,
data__locationId,
projectsId,
locationsId
)
SELECT 
'{{ inspectTemplate }}',
'{{ templateId }}',
'{{ locationId }}',
'{{ projectsId }}',
'{{ locationsId }}'
RETURNING
name,
createTime,
description,
displayName,
inspectConfig,
updateTime
;

organizations_locations_inspect_templates_create

Creates an InspectTemplate for reusing frequently used configuration for inspecting content, images, and storage. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.

INSERT INTO google.dlp.inspect_templates (
data__inspectTemplate,
data__templateId,
data__locationId,
organizationsId,
locationsId
)
SELECT 
'{{ inspectTemplate }}',
'{{ templateId }}',
'{{ locationId }}',
'{{ organizationsId }}',
'{{ locationsId }}'
RETURNING
name,
createTime,
description,
displayName,
inspectConfig,
updateTime
;

projects_inspect_templates_create

Creates an InspectTemplate for reusing frequently used configuration for inspecting content, images, and storage. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.

INSERT INTO google.dlp.inspect_templates (
data__inspectTemplate,
data__templateId,
data__locationId,
projectsId
)
SELECT 
'{{ inspectTemplate }}',
'{{ templateId }}',
'{{ locationId }}',
'{{ projectsId }}'
RETURNING
name,
createTime,
description,
displayName,
inspectConfig,
updateTime
;

organizations_inspect_templates_create

Creates an InspectTemplate for reusing frequently used configuration for inspecting content, images, and storage. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.

INSERT INTO google.dlp.inspect_templates (
data__inspectTemplate,
data__templateId,
data__locationId,
organizationsId
)
SELECT 
'{{ inspectTemplate }}',
'{{ templateId }}',
'{{ locationId }}',
'{{ organizationsId }}'
RETURNING
name,
createTime,
description,
displayName,
inspectConfig,
updateTime
;

Manifest

# Description fields are for documentation purposes
- name: inspect_templates
  props:
    - name: projectsId
      value: string
      description: Required parameter for the inspect_templates resource.
    - name: locationsId
      value: string
      description: Required parameter for the inspect_templates resource.
    - name: organizationsId
      value: string
      description: Required parameter for the inspect_templates resource.
    - name: inspectTemplate
      value: object
      description: >
        Required. The InspectTemplate to create.
        
    - name: templateId
      value: string
      description: >
        The template 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_inspect_templates_patch

Updates the InspectTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.

UPDATE google.dlp.inspect_templates
SET 
data__inspectTemplate = '{{ inspectTemplate }}',
data__updateMask = '{{ updateMask }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND inspectTemplatesId = '{{ inspectTemplatesId }}' --required
RETURNING
name,
createTime,
description,
displayName,
inspectConfig,
updateTime;

organizations_locations_inspect_templates_patch

Updates the InspectTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.

UPDATE google.dlp.inspect_templates
SET 
data__inspectTemplate = '{{ inspectTemplate }}',
data__updateMask = '{{ updateMask }}'
WHERE 
organizationsId = '{{ organizationsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND inspectTemplatesId = '{{ inspectTemplatesId }}' --required
RETURNING
name,
createTime,
description,
displayName,
inspectConfig,
updateTime;

projects_inspect_templates_patch

Updates the InspectTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.

UPDATE google.dlp.inspect_templates
SET 
data__inspectTemplate = '{{ inspectTemplate }}',
data__updateMask = '{{ updateMask }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND inspectTemplatesId = '{{ inspectTemplatesId }}' --required
RETURNING
name,
createTime,
description,
displayName,
inspectConfig,
updateTime;

organizations_inspect_templates_patch

Updates the InspectTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.

UPDATE google.dlp.inspect_templates
SET 
data__inspectTemplate = '{{ inspectTemplate }}',
data__updateMask = '{{ updateMask }}'
WHERE 
organizationsId = '{{ organizationsId }}' --required
AND inspectTemplatesId = '{{ inspectTemplatesId }}' --required
RETURNING
name,
createTime,
description,
displayName,
inspectConfig,
updateTime;

DELETE examples

projects_locations_inspect_templates_delete

Deletes an InspectTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.

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

organizations_locations_inspect_templates_delete

Deletes an InspectTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.

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

projects_inspect_templates_delete

Deletes an InspectTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.

DELETE FROM google.dlp.inspect_templates
WHERE projectsId = '{{ projectsId }}' --required
AND inspectTemplatesId = '{{ inspectTemplatesId }}' --required;

organizations_inspect_templates_delete

Deletes an InspectTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.

DELETE FROM google.dlp.inspect_templates
WHERE organizationsId = '{{ organizationsId }}' --required
AND inspectTemplatesId = '{{ inspectTemplatesId }}' --required;