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
- organizations_locations_inspect_templates_get
- projects_inspect_templates_get
- projects_locations_inspect_templates_list
- organizations_locations_inspect_templates_list
- organizations_inspect_templates_get
- projects_inspect_templates_list
- organizations_inspect_templates_list
| 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; |
allowLimitedAvailabilityInfoTypes | boolean | Optional. Enables the use of limited-availability built-in infoTypes in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere. |
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. |
| 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; |
allowLimitedAvailabilityInfoTypes | boolean | Optional. Enables the use of limited-availability built-in infoTypes in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere. |
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. |
| 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; |
allowLimitedAvailabilityInfoTypes | boolean | Optional. Enables the use of limited-availability built-in infoTypes in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere. |
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. |
| 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; |
allowLimitedAvailabilityInfoTypes | boolean | Optional. Enables the use of limited-availability built-in infoTypes in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere. |
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. |
| 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; |
allowLimitedAvailabilityInfoTypes | boolean | Optional. Enables the use of limited-availability built-in infoTypes in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere. |
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. |
| 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; |
allowLimitedAvailabilityInfoTypes | boolean | Optional. Enables the use of limited-availability built-in infoTypes in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere. |
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. |
| 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; |
allowLimitedAvailabilityInfoTypes | boolean | Optional. Enables the use of limited-availability built-in infoTypes in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere. |
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. |
| 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; |
allowLimitedAvailabilityInfoTypes | boolean | Optional. Enables the use of limited-availability built-in infoTypes in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere. |
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:
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
- organizations_locations_inspect_templates_get
- projects_inspect_templates_get
- projects_locations_inspect_templates_list
- organizations_locations_inspect_templates_list
- organizations_inspect_templates_get
- projects_inspect_templates_list
- organizations_inspect_templates_list
Gets an InspectTemplate. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.
SELECT
name,
allowLimitedAvailabilityInfoTypes,
createTime,
description,
displayName,
inspectConfig,
updateTime
FROM google.dlp.inspect_templates
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND inspectTemplatesId = '{{ inspectTemplatesId }}' -- required
;
Gets an InspectTemplate. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.
SELECT
name,
allowLimitedAvailabilityInfoTypes,
createTime,
description,
displayName,
inspectConfig,
updateTime
FROM google.dlp.inspect_templates
WHERE organizationsId = '{{ organizationsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND inspectTemplatesId = '{{ inspectTemplatesId }}' -- required
;
Gets an InspectTemplate. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.
SELECT
name,
allowLimitedAvailabilityInfoTypes,
createTime,
description,
displayName,
inspectConfig,
updateTime
FROM google.dlp.inspect_templates
WHERE projectsId = '{{ projectsId }}' -- required
AND inspectTemplatesId = '{{ inspectTemplatesId }}' -- required
;
Lists InspectTemplates. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.
SELECT
name,
allowLimitedAvailabilityInfoTypes,
createTime,
description,
displayName,
inspectConfig,
updateTime
FROM google.dlp.inspect_templates
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND locationId = '{{ locationId }}'
AND orderBy = '{{ orderBy }}'
AND pageToken = '{{ pageToken }}'
;
Lists InspectTemplates. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.
SELECT
name,
allowLimitedAvailabilityInfoTypes,
createTime,
description,
displayName,
inspectConfig,
updateTime
FROM google.dlp.inspect_templates
WHERE organizationsId = '{{ organizationsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageToken = '{{ pageToken }}'
AND orderBy = '{{ orderBy }}'
AND locationId = '{{ locationId }}'
AND pageSize = '{{ pageSize }}'
;
Gets an InspectTemplate. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.
SELECT
name,
allowLimitedAvailabilityInfoTypes,
createTime,
description,
displayName,
inspectConfig,
updateTime
FROM google.dlp.inspect_templates
WHERE organizationsId = '{{ organizationsId }}' -- required
AND inspectTemplatesId = '{{ inspectTemplatesId }}' -- required
;
Lists InspectTemplates. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.
SELECT
name,
allowLimitedAvailabilityInfoTypes,
createTime,
description,
displayName,
inspectConfig,
updateTime
FROM google.dlp.inspect_templates
WHERE projectsId = '{{ projectsId }}' -- required
AND orderBy = '{{ orderBy }}'
AND locationId = '{{ locationId }}'
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
;
Lists InspectTemplates. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.
SELECT
name,
allowLimitedAvailabilityInfoTypes,
createTime,
description,
displayName,
inspectConfig,
updateTime
FROM google.dlp.inspect_templates
WHERE organizationsId = '{{ organizationsId }}' -- required
AND pageToken = '{{ pageToken }}'
AND locationId = '{{ locationId }}'
AND pageSize = '{{ pageSize }}'
AND orderBy = '{{ orderBy }}'
;
INSERT examples
- projects_locations_inspect_templates_create
- organizations_locations_inspect_templates_create
- projects_inspect_templates_create
- organizations_inspect_templates_create
- Manifest
Creates an InspectTemplate for reusing frequently used configuration for inspecting content, images, and storage. See https://docs.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,
allowLimitedAvailabilityInfoTypes,
createTime,
description,
displayName,
inspectConfig,
updateTime
;
Creates an InspectTemplate for reusing frequently used configuration for inspecting content, images, and storage. See https://docs.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,
allowLimitedAvailabilityInfoTypes,
createTime,
description,
displayName,
inspectConfig,
updateTime
;
Creates an InspectTemplate for reusing frequently used configuration for inspecting content, images, and storage. See https://docs.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,
allowLimitedAvailabilityInfoTypes,
createTime,
description,
displayName,
inspectConfig,
updateTime
;
Creates an InspectTemplate for reusing frequently used configuration for inspecting content, images, and storage. See https://docs.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,
allowLimitedAvailabilityInfoTypes,
createTime,
description,
displayName,
inspectConfig,
updateTime
;
# Description fields are for documentation purposes
- name: inspect_templates
props:
- name: projectsId
value: "{{ projectsId }}"
description: Required parameter for the inspect_templates resource.
- name: locationsId
value: "{{ locationsId }}"
description: Required parameter for the inspect_templates resource.
- name: organizationsId
value: "{{ organizationsId }}"
description: Required parameter for the inspect_templates resource.
- name: inspectTemplate
description: |
Required. The InspectTemplate to create.
value:
updateTime: "{{ updateTime }}"
inspectConfig:
minLikelihoodPerInfoType:
- infoType:
name: "{{ name }}"
version: "{{ version }}"
sensitivityScore:
score: "{{ score }}"
minLikelihood: "{{ minLikelihood }}"
infoTypes:
- name: "{{ name }}"
version: "{{ version }}"
sensitivityScore:
score: "{{ score }}"
contentOptions:
- "{{ contentOptions }}"
minLikelihood: "{{ minLikelihood }}"
excludeInfoTypes: {{ excludeInfoTypes }}
customInfoTypes:
- likelihood: "{{ likelihood }}"
exclusionType: "{{ exclusionType }}"
surrogateType: "{{ surrogateType }}"
sensitivityScore:
score: "{{ score }}"
storedType:
name: "{{ name }}"
createTime: "{{ createTime }}"
metadataKeyValueExpression:
valueRegex: "{{ valueRegex }}"
keyRegex: "{{ keyRegex }}"
fileLabelInfoType:
sensitivityLabel:
guid: "{{ guid }}"
googleDriveLabel:
labelFieldsToMatch: "{{ labelFieldsToMatch }}"
labelId: "{{ labelId }}"
detectionRules: "{{ detectionRules }}"
infoType:
name: "{{ name }}"
version: "{{ version }}"
sensitivityScore:
score: "{{ score }}"
regex:
pattern: "{{ pattern }}"
groupIndexes:
- {{ groupIndexes }}
dictionary:
wordList:
words: "{{ words }}"
cloudStoragePath:
path: "{{ path }}"
limits:
maxFindingsPerInfoType:
- maxFindings: {{ maxFindings }}
infoType:
name: "{{ name }}"
version: "{{ version }}"
sensitivityScore: "{{ sensitivityScore }}"
maxFindingsPerRequest: {{ maxFindingsPerRequest }}
maxFindingsPerItem: {{ maxFindingsPerItem }}
ruleSet:
- rules: "{{ rules }}"
infoTypes: "{{ infoTypes }}"
includeQuote: {{ includeQuote }}
description: "{{ description }}"
createTime: "{{ createTime }}"
displayName: "{{ displayName }}"
allowLimitedAvailabilityInfoTypes: {{ allowLimitedAvailabilityInfoTypes }}
name: "{{ name }}"
- name: templateId
value: "{{ templateId }}"
description: |
The template id can contain uppercase and lowercase letters, numbers, and hyphens; that is, it must match the regular expression: `[a-zA-Zd-_]+`. The maximum length is 100 characters. Can be empty to allow the system to generate one.
- name: locationId
value: "{{ locationId }}"
description: |
Deprecated. This field has no effect.
UPDATE examples
- projects_locations_inspect_templates_patch
- organizations_locations_inspect_templates_patch
- projects_inspect_templates_patch
- organizations_inspect_templates_patch
Updates the InspectTemplate. See https://docs.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,
allowLimitedAvailabilityInfoTypes,
createTime,
description,
displayName,
inspectConfig,
updateTime;
Updates the InspectTemplate. See https://docs.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,
allowLimitedAvailabilityInfoTypes,
createTime,
description,
displayName,
inspectConfig,
updateTime;
Updates the InspectTemplate. See https://docs.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,
allowLimitedAvailabilityInfoTypes,
createTime,
description,
displayName,
inspectConfig,
updateTime;
Updates the InspectTemplate. See https://docs.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,
allowLimitedAvailabilityInfoTypes,
createTime,
description,
displayName,
inspectConfig,
updateTime;
DELETE examples
- projects_locations_inspect_templates_delete
- organizations_locations_inspect_templates_delete
- projects_inspect_templates_delete
- organizations_inspect_templates_delete
Deletes an InspectTemplate. See https://docs.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
;
Deletes an InspectTemplate. See https://docs.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
;
Deletes an InspectTemplate. See https://docs.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
;
Deletes an InspectTemplate. See https://docs.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
;