security_settings

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

Overview

Name	security_settings
Type	Resource
Id	google.dialogflow.security_settings

Fields

The following fields are returned by SELECT queries:

projects_locations_security_settings_get

Name	Datatype	Description
name	string
audioExportSettings	object	(id: GoogleCloudDialogflowCxV3SecuritySettingsAudioExportSettings)
deidentifyTemplate	string
displayName	string
insightsExportSettings	object	(id: GoogleCloudDialogflowCxV3SecuritySettingsInsightsExportSettings)
inspectTemplate	string
purgeDataTypes	array
redactionScope	string	(REDACTION_SCOPE_UNSPECIFIED, REDACT_DISK_STORAGE)
redactionStrategy	string	(REDACTION_STRATEGY_UNSPECIFIED, REDACT_WITH_SERVICE)
retentionStrategy	string	(RETENTION_STRATEGY_UNSPECIFIED, REMOVE_AFTER_CONVERSATION)
retentionWindowDays	integer (int32)

projects_locations_security_settings_list

Name	Datatype	Description
name	string
audioExportSettings	object	(id: GoogleCloudDialogflowCxV3SecuritySettingsAudioExportSettings)
deidentifyTemplate	string
displayName	string
insightsExportSettings	object	(id: GoogleCloudDialogflowCxV3SecuritySettingsInsightsExportSettings)
inspectTemplate	string
purgeDataTypes	array
redactionScope	string	(REDACTION_SCOPE_UNSPECIFIED, REDACT_DISK_STORAGE)
redactionStrategy	string	(REDACTION_STRATEGY_UNSPECIFIED, REDACT_WITH_SERVICE)
retentionStrategy	string	(RETENTION_STRATEGY_UNSPECIFIED, REMOVE_AFTER_CONVERSATION)
retentionWindowDays	integer (int32)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
projects_locations_security_settings_get	select	projectsId, locationsId, securitySettingsId
projects_locations_security_settings_list	select	projectsId, locationsId	pageToken, pageSize
projects_locations_security_settings_create	insert	projectsId, locationsId
projects_locations_security_settings_patch	update	projectsId, locationsId, securitySettingsId	updateMask
projects_locations_security_settings_delete	delete	projectsId, locationsId, securitySettingsId

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
projectsId	string
securitySettingsId	string
pageSize	integer (int32)
pageToken	string
updateMask	string (google-fieldmask)

SELECT examples

projects_locations_security_settings_get

Successful response

SELECT
name,
audioExportSettings,
deidentifyTemplate,
displayName,
insightsExportSettings,
inspectTemplate,
purgeDataTypes,
redactionScope,
redactionStrategy,
retentionStrategy,
retentionWindowDays
FROM google.dialogflow.security_settings
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND securitySettingsId = '{{ securitySettingsId }}' -- required
;

projects_locations_security_settings_list

Successful response

SELECT
name,
audioExportSettings,
deidentifyTemplate,
displayName,
insightsExportSettings,
inspectTemplate,
purgeDataTypes,
redactionScope,
redactionStrategy,
retentionStrategy,
retentionWindowDays
FROM google.dialogflow.security_settings
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageToken = '{{ pageToken }}'
AND pageSize = '{{ pageSize }}'
;

INSERT examples

projects_locations_security_settings_create

No description available.

INSERT INTO google.dialogflow.security_settings (
data__deidentifyTemplate,
data__retentionStrategy,
data__redactionScope,
data__redactionStrategy,
data__purgeDataTypes,
data__name,
data__inspectTemplate,
data__audioExportSettings,
data__insightsExportSettings,
data__displayName,
data__retentionWindowDays,
projectsId,
locationsId
)
SELECT 
'{{ deidentifyTemplate }}',
'{{ retentionStrategy }}',
'{{ redactionScope }}',
'{{ redactionStrategy }}',
'{{ purgeDataTypes }}',
'{{ name }}',
'{{ inspectTemplate }}',
'{{ audioExportSettings }}',
'{{ insightsExportSettings }}',
'{{ displayName }}',
{{ retentionWindowDays }},
'{{ projectsId }}',
'{{ locationsId }}'
RETURNING
name,
audioExportSettings,
deidentifyTemplate,
displayName,
insightsExportSettings,
inspectTemplate,
purgeDataTypes,
redactionScope,
redactionStrategy,
retentionStrategy,
retentionWindowDays
;

Manifest

# Description fields are for documentation purposes
- name: security_settings
props:
  - name: projectsId
    value: "{{ projectsId }}"
    description: Required parameter for the security_settings resource.
  - name: locationsId
    value: "{{ locationsId }}"
    description: Required parameter for the security_settings resource.
  - name: deidentifyTemplate
    value: "{{ deidentifyTemplate }}"
  - name: retentionStrategy
    value: "{{ retentionStrategy }}"
    valid_values: ['RETENTION_STRATEGY_UNSPECIFIED', 'REMOVE_AFTER_CONVERSATION']
  - name: redactionScope
    value: "{{ redactionScope }}"
    valid_values: ['REDACTION_SCOPE_UNSPECIFIED', 'REDACT_DISK_STORAGE']
  - name: redactionStrategy
    value: "{{ redactionStrategy }}"
    valid_values: ['REDACTION_STRATEGY_UNSPECIFIED', 'REDACT_WITH_SERVICE']
  - name: purgeDataTypes
    value:
      - "{{ purgeDataTypes }}"
  - name: name
    value: "{{ name }}"
  - name: inspectTemplate
    value: "{{ inspectTemplate }}"
  - name: audioExportSettings
    value:
      gcsBucket: "{{ gcsBucket }}"
      audioExportPattern: "{{ audioExportPattern }}"
      enableAudioRedaction: {{ enableAudioRedaction }}
      audioFormat: "{{ audioFormat }}"
      storeTtsAudio: {{ storeTtsAudio }}
  - name: insightsExportSettings
    value:
      enableInsightsExport: {{ enableInsightsExport }}
  - name: displayName
    value: "{{ displayName }}"
  - name: retentionWindowDays
    value: {{ retentionWindowDays }}

UPDATE examples

projects_locations_security_settings_patch

No description available.

UPDATE google.dialogflow.security_settings
SET 
data__deidentifyTemplate = '{{ deidentifyTemplate }}',
data__retentionStrategy = '{{ retentionStrategy }}',
data__redactionScope = '{{ redactionScope }}',
data__redactionStrategy = '{{ redactionStrategy }}',
data__purgeDataTypes = '{{ purgeDataTypes }}',
data__name = '{{ name }}',
data__inspectTemplate = '{{ inspectTemplate }}',
data__audioExportSettings = '{{ audioExportSettings }}',
data__insightsExportSettings = '{{ insightsExportSettings }}',
data__displayName = '{{ displayName }}',
data__retentionWindowDays = {{ retentionWindowDays }}
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND securitySettingsId = '{{ securitySettingsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
audioExportSettings,
deidentifyTemplate,
displayName,
insightsExportSettings,
inspectTemplate,
purgeDataTypes,
redactionScope,
redactionStrategy,
retentionStrategy,
retentionWindowDays;

DELETE examples

projects_locations_security_settings_delete

No description available.

DELETE FROM google.dialogflow.security_settings
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND securitySettingsId = '{{ securitySettingsId }}' --required
;