stored_info_types

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

Overview

Name	stored_info_types
Type	Resource
Id	google.dlp.stored_info_types

Fields

The following fields are returned by SELECT queries:

organizations_locations_stored_info_types_get

Name	Datatype	Description
name	string	Output only. Resource name.
currentVersion	object	Current version of the stored info type. (id: GooglePrivacyDlpV2StoredInfoTypeVersion)
pendingVersions	array	Pending versions of the stored info type. Empty if no versions are pending.

projects_locations_stored_info_types_get

Name	Datatype	Description
name	string	Output only. Resource name.
currentVersion	object	Current version of the stored info type. (id: GooglePrivacyDlpV2StoredInfoTypeVersion)
pendingVersions	array	Pending versions of the stored info type. Empty if no versions are pending.

organizations_locations_stored_info_types_list

Name	Datatype	Description
name	string	Output only. Resource name.
currentVersion	object	Current version of the stored info type. (id: GooglePrivacyDlpV2StoredInfoTypeVersion)
pendingVersions	array	Pending versions of the stored info type. Empty if no versions are pending.

organizations_stored_info_types_get

Name	Datatype	Description
name	string	Output only. Resource name.
currentVersion	object	Current version of the stored info type. (id: GooglePrivacyDlpV2StoredInfoTypeVersion)
pendingVersions	array	Pending versions of the stored info type. Empty if no versions are pending.

projects_locations_stored_info_types_list

Name	Datatype	Description
name	string	Output only. Resource name.
currentVersion	object	Current version of the stored info type. (id: GooglePrivacyDlpV2StoredInfoTypeVersion)
pendingVersions	array	Pending versions of the stored info type. Empty if no versions are pending.

projects_stored_info_types_get

Name	Datatype	Description
name	string	Output only. Resource name.
currentVersion	object	Current version of the stored info type. (id: GooglePrivacyDlpV2StoredInfoTypeVersion)
pendingVersions	array	Pending versions of the stored info type. Empty if no versions are pending.

organizations_stored_info_types_list

Name	Datatype	Description
name	string	Output only. Resource name.
currentVersion	object	Current version of the stored info type. (id: GooglePrivacyDlpV2StoredInfoTypeVersion)
pendingVersions	array	Pending versions of the stored info type. Empty if no versions are pending.

projects_stored_info_types_list

Name	Datatype	Description
name	string	Output only. Resource name.
currentVersion	object	Current version of the stored info type. (id: GooglePrivacyDlpV2StoredInfoTypeVersion)
pendingVersions	array	Pending versions of the stored info type. Empty if no versions are pending.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
organizations_locations_stored_info_types_get	select	organizationsId, locationsId, storedInfoTypesId		Gets a stored infoType. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.
projects_locations_stored_info_types_get	select	projectsId, locationsId, storedInfoTypesId		Gets a stored infoType. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.
organizations_locations_stored_info_types_list	select	organizationsId, locationsId	locationId, orderBy, pageSize, pageToken	Lists stored infoTypes. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.
organizations_stored_info_types_get	select	organizationsId, storedInfoTypesId		Gets a stored infoType. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.
projects_locations_stored_info_types_list	select	projectsId, locationsId	locationId, orderBy, pageSize, pageToken	Lists stored infoTypes. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.
projects_stored_info_types_get	select	projectsId, storedInfoTypesId		Gets a stored infoType. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.
organizations_stored_info_types_list	select	organizationsId	locationId, orderBy, pageSize, pageToken	Lists stored infoTypes. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.
projects_stored_info_types_list	select	projectsId	locationId, orderBy, pageSize, pageToken	Lists stored infoTypes. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.
organizations_locations_stored_info_types_create	insert	organizationsId, locationsId		Creates a pre-built stored infoType to be used for inspection. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.
projects_locations_stored_info_types_create	insert	projectsId, locationsId		Creates a pre-built stored infoType to be used for inspection. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.
organizations_stored_info_types_create	insert	organizationsId		Creates a pre-built stored infoType to be used for inspection. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.
projects_stored_info_types_create	insert	projectsId		Creates a pre-built stored infoType to be used for inspection. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.
organizations_locations_stored_info_types_patch	update	organizationsId, locationsId, storedInfoTypesId		Updates the stored infoType by creating a new version. The existing version will continue to be used until the new version is ready. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.
projects_locations_stored_info_types_patch	update	projectsId, locationsId, storedInfoTypesId		Updates the stored infoType by creating a new version. The existing version will continue to be used until the new version is ready. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.
organizations_stored_info_types_patch	update	organizationsId, storedInfoTypesId		Updates the stored infoType by creating a new version. The existing version will continue to be used until the new version is ready. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.
projects_stored_info_types_patch	update	projectsId, storedInfoTypesId		Updates the stored infoType by creating a new version. The existing version will continue to be used until the new version is ready. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.
organizations_locations_stored_info_types_delete	delete	organizationsId, locationsId, storedInfoTypesId		Deletes a stored infoType. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.
projects_locations_stored_info_types_delete	delete	projectsId, locationsId, storedInfoTypesId		Deletes a stored infoType. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.
organizations_stored_info_types_delete	delete	organizationsId, storedInfoTypesId		Deletes a stored infoType. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.
projects_stored_info_types_delete	delete	projectsId, storedInfoTypesId		Deletes a stored infoType. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes 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
locationsId	string
organizationsId	string
projectsId	string
storedInfoTypesId	string
locationId	string
orderBy	string
pageSize	integer (int32)
pageToken	string

SELECT examples

organizations_locations_stored_info_types_get

Gets a stored infoType. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.

SELECT
name,
currentVersion,
pendingVersions
FROM google.dlp.stored_info_types
WHERE organizationsId = '{{ organizationsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND storedInfoTypesId = '{{ storedInfoTypesId }}' -- required
;

projects_locations_stored_info_types_get

Gets a stored infoType. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.

SELECT
name,
currentVersion,
pendingVersions
FROM google.dlp.stored_info_types
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND storedInfoTypesId = '{{ storedInfoTypesId }}' -- required
;

organizations_locations_stored_info_types_list

Lists stored infoTypes. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.

SELECT
name,
currentVersion,
pendingVersions
FROM google.dlp.stored_info_types
WHERE organizationsId = '{{ organizationsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND locationId = '{{ locationId }}'
AND orderBy = '{{ orderBy }}'
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
;

organizations_stored_info_types_get

Gets a stored infoType. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.

SELECT
name,
currentVersion,
pendingVersions
FROM google.dlp.stored_info_types
WHERE organizationsId = '{{ organizationsId }}' -- required
AND storedInfoTypesId = '{{ storedInfoTypesId }}' -- required
;

projects_locations_stored_info_types_list

Lists stored infoTypes. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.

SELECT
name,
currentVersion,
pendingVersions
FROM google.dlp.stored_info_types
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND locationId = '{{ locationId }}'
AND orderBy = '{{ orderBy }}'
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
;

projects_stored_info_types_get

Gets a stored infoType. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.

SELECT
name,
currentVersion,
pendingVersions
FROM google.dlp.stored_info_types
WHERE projectsId = '{{ projectsId }}' -- required
AND storedInfoTypesId = '{{ storedInfoTypesId }}' -- required
;

organizations_stored_info_types_list

Lists stored infoTypes. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.

SELECT
name,
currentVersion,
pendingVersions
FROM google.dlp.stored_info_types
WHERE organizationsId = '{{ organizationsId }}' -- required
AND locationId = '{{ locationId }}'
AND orderBy = '{{ orderBy }}'
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
;

projects_stored_info_types_list

Lists stored infoTypes. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.

SELECT
name,
currentVersion,
pendingVersions
FROM google.dlp.stored_info_types
WHERE projectsId = '{{ projectsId }}' -- required
AND locationId = '{{ locationId }}'
AND orderBy = '{{ orderBy }}'
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
;

INSERT examples

organizations_locations_stored_info_types_create

Creates a pre-built stored infoType to be used for inspection. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.

INSERT INTO google.dlp.stored_info_types (
data__config,
data__locationId,
data__storedInfoTypeId,
organizationsId,
locationsId
)
SELECT 
'{{ config }}',
'{{ locationId }}',
'{{ storedInfoTypeId }}',
'{{ organizationsId }}',
'{{ locationsId }}'
RETURNING
name,
currentVersion,
pendingVersions
;

projects_locations_stored_info_types_create

Creates a pre-built stored infoType to be used for inspection. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.

INSERT INTO google.dlp.stored_info_types (
data__config,
data__locationId,
data__storedInfoTypeId,
projectsId,
locationsId
)
SELECT 
'{{ config }}',
'{{ locationId }}',
'{{ storedInfoTypeId }}',
'{{ projectsId }}',
'{{ locationsId }}'
RETURNING
name,
currentVersion,
pendingVersions
;

organizations_stored_info_types_create

Creates a pre-built stored infoType to be used for inspection. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.

INSERT INTO google.dlp.stored_info_types (
data__config,
data__locationId,
data__storedInfoTypeId,
organizationsId
)
SELECT 
'{{ config }}',
'{{ locationId }}',
'{{ storedInfoTypeId }}',
'{{ organizationsId }}'
RETURNING
name,
currentVersion,
pendingVersions
;

projects_stored_info_types_create

Creates a pre-built stored infoType to be used for inspection. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.

INSERT INTO google.dlp.stored_info_types (
data__config,
data__locationId,
data__storedInfoTypeId,
projectsId
)
SELECT 
'{{ config }}',
'{{ locationId }}',
'{{ storedInfoTypeId }}',
'{{ projectsId }}'
RETURNING
name,
currentVersion,
pendingVersions
;

Manifest

# Description fields are for documentation purposes
- name: stored_info_types
props:
  - name: organizationsId
    value: "{{ organizationsId }}"
    description: Required parameter for the stored_info_types resource.
  - name: locationsId
    value: "{{ locationsId }}"
    description: Required parameter for the stored_info_types resource.
  - name: projectsId
    value: "{{ projectsId }}"
    description: Required parameter for the stored_info_types resource.
  - name: config
    description: |
      Required. Configuration of the storedInfoType to create.
    value:
      description: "{{ description }}"
      dictionary:
        cloudStoragePath:
          path: "{{ path }}"
        wordList:
          words:
            - "{{ words }}"
      displayName: "{{ displayName }}"
      largeCustomDictionary:
        bigQueryField:
          field:
            name: "{{ name }}"
          table:
            datasetId: "{{ datasetId }}"
            projectId: "{{ projectId }}"
            tableId: "{{ tableId }}"
        cloudStorageFileSet:
          url: "{{ url }}"
        outputPath:
          path: "{{ path }}"
      regex:
        groupIndexes:
          - {{ groupIndexes }}
        pattern: "{{ pattern }}"
  - name: locationId
    value: "{{ locationId }}"
    description: |
      Deprecated. This field has no effect.
  - name: storedInfoTypeId
    value: "{{ storedInfoTypeId }}"
    description: |
      The storedInfoType 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.

UPDATE examples

organizations_locations_stored_info_types_patch

Updates the stored infoType by creating a new version. The existing version will continue to be used until the new version is ready. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.

UPDATE google.dlp.stored_info_types
SET 
data__config = '{{ config }}',
data__updateMask = '{{ updateMask }}'
WHERE 
organizationsId = '{{ organizationsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND storedInfoTypesId = '{{ storedInfoTypesId }}' --required
RETURNING
name,
currentVersion,
pendingVersions;

projects_locations_stored_info_types_patch

Updates the stored infoType by creating a new version. The existing version will continue to be used until the new version is ready. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.

UPDATE google.dlp.stored_info_types
SET 
data__config = '{{ config }}',
data__updateMask = '{{ updateMask }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND storedInfoTypesId = '{{ storedInfoTypesId }}' --required
RETURNING
name,
currentVersion,
pendingVersions;

organizations_stored_info_types_patch

Updates the stored infoType by creating a new version. The existing version will continue to be used until the new version is ready. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.

UPDATE google.dlp.stored_info_types
SET 
data__config = '{{ config }}',
data__updateMask = '{{ updateMask }}'
WHERE 
organizationsId = '{{ organizationsId }}' --required
AND storedInfoTypesId = '{{ storedInfoTypesId }}' --required
RETURNING
name,
currentVersion,
pendingVersions;

projects_stored_info_types_patch

Updates the stored infoType by creating a new version. The existing version will continue to be used until the new version is ready. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.

UPDATE google.dlp.stored_info_types
SET 
data__config = '{{ config }}',
data__updateMask = '{{ updateMask }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND storedInfoTypesId = '{{ storedInfoTypesId }}' --required
RETURNING
name,
currentVersion,
pendingVersions;

DELETE examples

organizations_locations_stored_info_types_delete

Deletes a stored infoType. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.

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

projects_locations_stored_info_types_delete

Deletes a stored infoType. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.

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

organizations_stored_info_types_delete

Deletes a stored infoType. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.

DELETE FROM google.dlp.stored_info_types
WHERE organizationsId = '{{ organizationsId }}' --required
AND storedInfoTypesId = '{{ storedInfoTypesId }}' --required
;

projects_stored_info_types_delete

Deletes a stored infoType. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.

DELETE FROM google.dlp.stored_info_types
WHERE projectsId = '{{ projectsId }}' --required
AND storedInfoTypesId = '{{ storedInfoTypesId }}' --required
;