deidentify_templates

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

Overview

Name	deidentify_templates
Type	Resource
Id	google.dlp.deidentify_templates

Fields

The following fields are returned by SELECT queries:

projects_locations_deidentify_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/deidentifyTemplates/TEMPLATE_ID OR organizations/ORGANIZATION_ID/deidentifyTemplates/TEMPLATE_ID
createTime	string (google-datetime)	Output only. The creation timestamp of an inspectTemplate.
deidentifyConfig	object	The core content of the template. (id: GooglePrivacyDlpV2DeidentifyConfig)
description	string	Short description (max 256 chars).
displayName	string	Display name (max 256 chars).
updateTime	string (google-datetime)	Output only. The last update timestamp of an inspectTemplate.

organizations_locations_deidentify_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/deidentifyTemplates/TEMPLATE_ID OR organizations/ORGANIZATION_ID/deidentifyTemplates/TEMPLATE_ID
createTime	string (google-datetime)	Output only. The creation timestamp of an inspectTemplate.
deidentifyConfig	object	The core content of the template. (id: GooglePrivacyDlpV2DeidentifyConfig)
description	string	Short description (max 256 chars).
displayName	string	Display name (max 256 chars).
updateTime	string (google-datetime)	Output only. The last update timestamp of an inspectTemplate.

projects_locations_deidentify_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/deidentifyTemplates/TEMPLATE_ID OR organizations/ORGANIZATION_ID/deidentifyTemplates/TEMPLATE_ID
createTime	string (google-datetime)	Output only. The creation timestamp of an inspectTemplate.
deidentifyConfig	object	The core content of the template. (id: GooglePrivacyDlpV2DeidentifyConfig)
description	string	Short description (max 256 chars).
displayName	string	Display name (max 256 chars).
updateTime	string (google-datetime)	Output only. The last update timestamp of an inspectTemplate.

projects_deidentify_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/deidentifyTemplates/TEMPLATE_ID OR organizations/ORGANIZATION_ID/deidentifyTemplates/TEMPLATE_ID
createTime	string (google-datetime)	Output only. The creation timestamp of an inspectTemplate.
deidentifyConfig	object	The core content of the template. (id: GooglePrivacyDlpV2DeidentifyConfig)
description	string	Short description (max 256 chars).
displayName	string	Display name (max 256 chars).
updateTime	string (google-datetime)	Output only. The last update timestamp of an inspectTemplate.

organizations_locations_deidentify_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/deidentifyTemplates/TEMPLATE_ID OR organizations/ORGANIZATION_ID/deidentifyTemplates/TEMPLATE_ID
createTime	string (google-datetime)	Output only. The creation timestamp of an inspectTemplate.
deidentifyConfig	object	The core content of the template. (id: GooglePrivacyDlpV2DeidentifyConfig)
description	string	Short description (max 256 chars).
displayName	string	Display name (max 256 chars).
updateTime	string (google-datetime)	Output only. The last update timestamp of an inspectTemplate.

organizations_deidentify_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/deidentifyTemplates/TEMPLATE_ID OR organizations/ORGANIZATION_ID/deidentifyTemplates/TEMPLATE_ID
createTime	string (google-datetime)	Output only. The creation timestamp of an inspectTemplate.
deidentifyConfig	object	The core content of the template. (id: GooglePrivacyDlpV2DeidentifyConfig)
description	string	Short description (max 256 chars).
displayName	string	Display name (max 256 chars).
updateTime	string (google-datetime)	Output only. The last update timestamp of an inspectTemplate.

projects_deidentify_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/deidentifyTemplates/TEMPLATE_ID OR organizations/ORGANIZATION_ID/deidentifyTemplates/TEMPLATE_ID
createTime	string (google-datetime)	Output only. The creation timestamp of an inspectTemplate.
deidentifyConfig	object	The core content of the template. (id: GooglePrivacyDlpV2DeidentifyConfig)
description	string	Short description (max 256 chars).
displayName	string	Display name (max 256 chars).
updateTime	string (google-datetime)	Output only. The last update timestamp of an inspectTemplate.

organizations_deidentify_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/deidentifyTemplates/TEMPLATE_ID OR organizations/ORGANIZATION_ID/deidentifyTemplates/TEMPLATE_ID
createTime	string (google-datetime)	Output only. The creation timestamp of an inspectTemplate.
deidentifyConfig	object	The core content of the template. (id: GooglePrivacyDlpV2DeidentifyConfig)
description	string	Short description (max 256 chars).
displayName	string	Display name (max 256 chars).
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_deidentify_templates_get	select	projectsId, locationsId, deidentifyTemplatesId		Gets a DeidentifyTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.
organizations_locations_deidentify_templates_get	select	organizationsId, locationsId, deidentifyTemplatesId		Gets a DeidentifyTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.
projects_locations_deidentify_templates_list	select	projectsId, locationsId	pageToken, pageSize, orderBy, locationId	Lists DeidentifyTemplates. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.
projects_deidentify_templates_get	select	projectsId, deidentifyTemplatesId		Gets a DeidentifyTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.
organizations_locations_deidentify_templates_list	select	organizationsId, locationsId	pageToken, pageSize, orderBy, locationId	Lists DeidentifyTemplates. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.
organizations_deidentify_templates_get	select	organizationsId, deidentifyTemplatesId		Gets a DeidentifyTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.
projects_deidentify_templates_list	select	projectsId	pageToken, pageSize, orderBy, locationId	Lists DeidentifyTemplates. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.
organizations_deidentify_templates_list	select	organizationsId	pageToken, pageSize, orderBy, locationId	Lists DeidentifyTemplates. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.
projects_locations_deidentify_templates_create	insert	projectsId, locationsId		Creates a DeidentifyTemplate for reusing frequently used configuration for de-identifying content, images, and storage. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.
organizations_locations_deidentify_templates_create	insert	organizationsId, locationsId		Creates a DeidentifyTemplate for reusing frequently used configuration for de-identifying content, images, and storage. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.
projects_deidentify_templates_create	insert	projectsId		Creates a DeidentifyTemplate for reusing frequently used configuration for de-identifying content, images, and storage. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.
organizations_deidentify_templates_create	insert	organizationsId		Creates a DeidentifyTemplate for reusing frequently used configuration for de-identifying content, images, and storage. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.
projects_locations_deidentify_templates_patch	update	projectsId, locationsId, deidentifyTemplatesId		Updates the DeidentifyTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.
organizations_locations_deidentify_templates_patch	update	organizationsId, locationsId, deidentifyTemplatesId		Updates the DeidentifyTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.
projects_deidentify_templates_patch	update	projectsId, deidentifyTemplatesId		Updates the DeidentifyTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.
organizations_deidentify_templates_patch	update	organizationsId, deidentifyTemplatesId		Updates the DeidentifyTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.
projects_locations_deidentify_templates_delete	delete	projectsId, locationsId, deidentifyTemplatesId		Deletes a DeidentifyTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.
organizations_locations_deidentify_templates_delete	delete	organizationsId, locationsId, deidentifyTemplatesId		Deletes a DeidentifyTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.
projects_deidentify_templates_delete	delete	projectsId, deidentifyTemplatesId		Deletes a DeidentifyTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.
organizations_deidentify_templates_delete	delete	organizationsId, deidentifyTemplatesId		Deletes a DeidentifyTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid 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
deidentifyTemplatesId	string
locationsId	string
organizationsId	string
projectsId	string
locationId	string
orderBy	string
pageSize	integer (int32)
pageToken	string

SELECT examples

projects_locations_deidentify_templates_get

Gets a DeidentifyTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.

SELECT
name,
createTime,
deidentifyConfig,
description,
displayName,
updateTime
FROM google.dlp.deidentify_templates
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND deidentifyTemplatesId = '{{ deidentifyTemplatesId }}' -- required;

organizations_locations_deidentify_templates_get

Gets a DeidentifyTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.

SELECT
name,
createTime,
deidentifyConfig,
description,
displayName,
updateTime
FROM google.dlp.deidentify_templates
WHERE organizationsId = '{{ organizationsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND deidentifyTemplatesId = '{{ deidentifyTemplatesId }}' -- required;

projects_locations_deidentify_templates_list

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

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

projects_deidentify_templates_get

Gets a DeidentifyTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.

SELECT
name,
createTime,
deidentifyConfig,
description,
displayName,
updateTime
FROM google.dlp.deidentify_templates
WHERE projectsId = '{{ projectsId }}' -- required
AND deidentifyTemplatesId = '{{ deidentifyTemplatesId }}' -- required;

organizations_locations_deidentify_templates_list

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

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

organizations_deidentify_templates_get

Gets a DeidentifyTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.

SELECT
name,
createTime,
deidentifyConfig,
description,
displayName,
updateTime
FROM google.dlp.deidentify_templates
WHERE organizationsId = '{{ organizationsId }}' -- required
AND deidentifyTemplatesId = '{{ deidentifyTemplatesId }}' -- required;

projects_deidentify_templates_list

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

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

organizations_deidentify_templates_list

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

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

INSERT examples

projects_locations_deidentify_templates_create

Creates a DeidentifyTemplate for reusing frequently used configuration for de-identifying content, images, and storage. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.

INSERT INTO google.dlp.deidentify_templates (
data__deidentifyTemplate,
data__templateId,
data__locationId,
projectsId,
locationsId
)
SELECT 
'{{ deidentifyTemplate }}',
'{{ templateId }}',
'{{ locationId }}',
'{{ projectsId }}',
'{{ locationsId }}'
RETURNING
name,
createTime,
deidentifyConfig,
description,
displayName,
updateTime
;

organizations_locations_deidentify_templates_create

Creates a DeidentifyTemplate for reusing frequently used configuration for de-identifying content, images, and storage. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.

INSERT INTO google.dlp.deidentify_templates (
data__deidentifyTemplate,
data__templateId,
data__locationId,
organizationsId,
locationsId
)
SELECT 
'{{ deidentifyTemplate }}',
'{{ templateId }}',
'{{ locationId }}',
'{{ organizationsId }}',
'{{ locationsId }}'
RETURNING
name,
createTime,
deidentifyConfig,
description,
displayName,
updateTime
;

projects_deidentify_templates_create

Creates a DeidentifyTemplate for reusing frequently used configuration for de-identifying content, images, and storage. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.

INSERT INTO google.dlp.deidentify_templates (
data__deidentifyTemplate,
data__templateId,
data__locationId,
projectsId
)
SELECT 
'{{ deidentifyTemplate }}',
'{{ templateId }}',
'{{ locationId }}',
'{{ projectsId }}'
RETURNING
name,
createTime,
deidentifyConfig,
description,
displayName,
updateTime
;

organizations_deidentify_templates_create

Creates a DeidentifyTemplate for reusing frequently used configuration for de-identifying content, images, and storage. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.

INSERT INTO google.dlp.deidentify_templates (
data__deidentifyTemplate,
data__templateId,
data__locationId,
organizationsId
)
SELECT 
'{{ deidentifyTemplate }}',
'{{ templateId }}',
'{{ locationId }}',
'{{ organizationsId }}'
RETURNING
name,
createTime,
deidentifyConfig,
description,
displayName,
updateTime
;

Manifest

# Description fields are for documentation purposes
- name: deidentify_templates
  props:
    - name: projectsId
      value: string
      description: Required parameter for the deidentify_templates resource.
    - name: locationsId
      value: string
      description: Required parameter for the deidentify_templates resource.
    - name: organizationsId
      value: string
      description: Required parameter for the deidentify_templates resource.
    - name: deidentifyTemplate
      value: object
      description: >
        Required. The DeidentifyTemplate 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_deidentify_templates_patch

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

UPDATE google.dlp.deidentify_templates
SET 
data__deidentifyTemplate = '{{ deidentifyTemplate }}',
data__updateMask = '{{ updateMask }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND deidentifyTemplatesId = '{{ deidentifyTemplatesId }}' --required
RETURNING
name,
createTime,
deidentifyConfig,
description,
displayName,
updateTime;

organizations_locations_deidentify_templates_patch

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

UPDATE google.dlp.deidentify_templates
SET 
data__deidentifyTemplate = '{{ deidentifyTemplate }}',
data__updateMask = '{{ updateMask }}'
WHERE 
organizationsId = '{{ organizationsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND deidentifyTemplatesId = '{{ deidentifyTemplatesId }}' --required
RETURNING
name,
createTime,
deidentifyConfig,
description,
displayName,
updateTime;

projects_deidentify_templates_patch

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

UPDATE google.dlp.deidentify_templates
SET 
data__deidentifyTemplate = '{{ deidentifyTemplate }}',
data__updateMask = '{{ updateMask }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND deidentifyTemplatesId = '{{ deidentifyTemplatesId }}' --required
RETURNING
name,
createTime,
deidentifyConfig,
description,
displayName,
updateTime;

organizations_deidentify_templates_patch

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

UPDATE google.dlp.deidentify_templates
SET 
data__deidentifyTemplate = '{{ deidentifyTemplate }}',
data__updateMask = '{{ updateMask }}'
WHERE 
organizationsId = '{{ organizationsId }}' --required
AND deidentifyTemplatesId = '{{ deidentifyTemplatesId }}' --required
RETURNING
name,
createTime,
deidentifyConfig,
description,
displayName,
updateTime;

DELETE examples

projects_locations_deidentify_templates_delete

Deletes a DeidentifyTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.

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

organizations_locations_deidentify_templates_delete

Deletes a DeidentifyTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.

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

projects_deidentify_templates_delete

Deletes a DeidentifyTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.

DELETE FROM google.dlp.deidentify_templates
WHERE projectsId = '{{ projectsId }}' --required
AND deidentifyTemplatesId = '{{ deidentifyTemplatesId }}' --required;

organizations_deidentify_templates_delete

Deletes a DeidentifyTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.

DELETE FROM google.dlp.deidentify_templates
WHERE organizationsId = '{{ organizationsId }}' --required
AND deidentifyTemplatesId = '{{ deidentifyTemplatesId }}' --required;