security_settings

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

Overview

Name	security_settings
Type	Resource
Id	google.dialogflow.security_settings

Fields

Name	Datatype	Description
name	string	Resource name of the settings. Required for the SecuritySettingsService.UpdateSecuritySettings method. SecuritySettingsService.CreateSecuritySettings populates the name automatically. Format: projects//locations//securitySettings/.
audioExportSettings	object	Settings for exporting audio.
deidentifyTemplate	string	DLP deidentify template name. Use this template to define de-identification configuration for the content. The DLP De-identify Templates Reader role is needed on the Dialogflow service identity service account (has the form service-PROJECT_NUMBER@gcp-sa-dialogflow.iam.gserviceaccount.com) for your agent's project. If empty, Dialogflow replaces sensitive info with [redacted] text. The template name will have one of the following formats: projects//locations//deidentifyTemplates/ OR organizations//locations//deidentifyTemplates/ Note: deidentify_template must be located in the same region as the SecuritySettings.
displayName	string	Required. The human-readable name of the security settings, unique within the location.
insightsExportSettings	object	Settings for exporting conversations to Insights.
inspectTemplate	string	DLP inspect template name. Use this template to define inspect base settings. The DLP Inspect Templates Reader role is needed on the Dialogflow service identity service account (has the form service-PROJECT_NUMBER@gcp-sa-dialogflow.iam.gserviceaccount.com) for your agent's project. If empty, we use the default DLP inspect config. The template name will have one of the following formats: projects//locations//inspectTemplates/ OR organizations//locations//inspectTemplates/ Note: inspect_template must be located in the same region as the SecuritySettings.
purgeDataTypes	array	List of types of data to remove when retention settings triggers purge.
redactionScope	string	Defines the data for which Dialogflow applies redaction. Dialogflow does not redact data that it does not have access to – for example, Cloud logging.
redactionStrategy	string	Strategy that defines how we do redaction.
retentionStrategy	string	Specifies the retention behavior defined by SecuritySettings.RetentionStrategy.
retentionWindowDays	integer	Retains the data for the specified number of days. User must set a value lower than Dialogflow's default 365d TTL (30 days for Agent Assist traffic), higher value will be ignored and use default. Setting a value higher than that has no effect. A missing value or setting to 0 also means we use default TTL. When data retention configuration is changed, it only applies to the data created after the change; the TTL of existing data created before the change stays intact.

Methods

Name	Accessible by	Required Params	Description
projects_locations_security_settings_get	SELECT	locationsId, projectsId, securitySettingsId	Retrieves the specified SecuritySettings. The returned settings may be stale by up to 1 minute.
projects_locations_security_settings_list	SELECT	locationsId, projectsId	Returns the list of all security settings in the specified location.
projects_locations_security_settings_create	INSERT	locationsId, projectsId	Create security settings in the specified location.
projects_locations_security_settings_delete	DELETE	locationsId, projectsId, securitySettingsId	Deletes the specified SecuritySettings.
projects_locations_security_settings_patch	UPDATE	locationsId, projectsId, securitySettingsId	Updates the specified SecuritySettings.

SELECT examples

Returns the list of all security settings in the specified location.

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

INSERT example

Use the following StackQL query and manifest file to create a new security_settings resource.

All Properties

/*+ create */
INSERT INTO google.dialogflow.security_settings (
locationsId,
projectsId,
name,
displayName,
redactionStrategy,
redactionScope,
inspectTemplate,
deidentifyTemplate,
retentionWindowDays,
retentionStrategy,
purgeDataTypes,
audioExportSettings,
insightsExportSettings
)
SELECT 
'{{ locationsId }}',
'{{ projectsId }}',
'{{ name }}',
'{{ displayName }}',
'{{ redactionStrategy }}',
'{{ redactionScope }}',
'{{ inspectTemplate }}',
'{{ deidentifyTemplate }}',
'{{ retentionWindowDays }}',
'{{ retentionStrategy }}',
'{{ purgeDataTypes }}',
'{{ audioExportSettings }}',
'{{ insightsExportSettings }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: name
      value: string
    - name: displayName
      value: string
    - name: redactionStrategy
      value: string
    - name: redactionScope
      value: string
    - name: inspectTemplate
      value: string
    - name: deidentifyTemplate
      value: string
    - name: retentionWindowDays
      value: integer
    - name: retentionStrategy
      value: string
    - name: purgeDataTypes
      value:
        - string
    - name: audioExportSettings
      value:
        - name: gcsBucket
          value: string
        - name: audioExportPattern
          value: string
        - name: enableAudioRedaction
          value: boolean
        - name: audioFormat
          value: string
        - name: storeTtsAudio
          value: boolean
    - name: insightsExportSettings
      value:
        - name: enableInsightsExport
          value: boolean

UPDATE example

Updates a security_settings resource.

/*+ update */
UPDATE google.dialogflow.security_settings
SET 
name = '{{ name }}',
displayName = '{{ displayName }}',
redactionStrategy = '{{ redactionStrategy }}',
redactionScope = '{{ redactionScope }}',
inspectTemplate = '{{ inspectTemplate }}',
deidentifyTemplate = '{{ deidentifyTemplate }}',
retentionWindowDays = '{{ retentionWindowDays }}',
retentionStrategy = '{{ retentionStrategy }}',
purgeDataTypes = '{{ purgeDataTypes }}',
audioExportSettings = '{{ audioExportSettings }}',
insightsExportSettings = '{{ insightsExportSettings }}'
WHERE 
locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}'
AND securitySettingsId = '{{ securitySettingsId }}';

DELETE example

Deletes the specified security_settings resource.

/*+ delete */
DELETE FROM google.dialogflow.security_settings
WHERE locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}'
AND securitySettingsId = '{{ securitySettingsId }}';