Class SecuritySettings (1.33.0)

SecuritySettings(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Represents the settings related to security issues, such as data redaction and data retention. It may take hours for updates on the settings to propagate to all the related components and take effect.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Attributes
Name	Description
`name`	`str` Resource name of the settings. Required for the SecuritySettingsService.UpdateSecuritySettings method. SecuritySettingsService.CreateSecuritySettings populates the name automatically. Format: `projects/`.
`display_name`	`str` Required. The human-readable name of the security settings, unique within the location.
`redaction_strategy`	`google.cloud.dialogflowcx_v3.types.SecuritySettings.RedactionStrategy` Strategy that defines how we do redaction.
`redaction_scope`	`google.cloud.dialogflowcx_v3.types.SecuritySettings.RedactionScope` Defines the data for which Dialogflow applies redaction. Dialogflow does not redact data that it does not have access to – for example, Cloud logging.
`inspect_template`	`str` `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/` OR `organizations/` Note: `inspect_template` must be located in the same region as the `SecuritySettings`.
`deidentify_template`	`str` `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/` OR `organizations/` Note: `deidentify_template` must be located in the same region as the `SecuritySettings`.
`retention_window_days`	`int` 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. This field is a member of `oneof`_ `data_retention`.
`retention_strategy`	`google.cloud.dialogflowcx_v3.types.SecuritySettings.RetentionStrategy` Specifies the retention behavior defined by SecuritySettings.RetentionStrategy. This field is a member of `oneof`_ `data_retention`.
`purge_data_types`	`MutableSequence[google.cloud.dialogflowcx_v3.types.SecuritySettings.PurgeDataType]` List of types of data to remove when retention settings triggers purge.
`audio_export_settings`	`google.cloud.dialogflowcx_v3.types.SecuritySettings.AudioExportSettings` Controls audio export settings for post-conversation analytics when ingesting audio to conversations via [Participants.AnalyzeContent][] or [Participants.StreamingAnalyzeContent][]. If retention_strategy is set to REMOVE_AFTER_CONVERSATION or [audio_export_settings.gcs_bucket][] is empty, audio export is disabled. If audio export is enabled, audio is recorded and saved to [audio_export_settings.gcs_bucket][], subject to retention policy of [audio_export_settings.gcs_bucket][]. This setting won't effect audio input for implicit sessions via Sessions.DetectIntent or Sessions.StreamingDetectIntent.
`insights_export_settings`	`google.cloud.dialogflowcx_v3.types.SecuritySettings.InsightsExportSettings` Controls conversation exporting settings to Insights after conversation is completed. If retention_strategy is set to REMOVE_AFTER_CONVERSATION, Insights export is disabled no matter what you configure here.

Classes

AudioExportSettings

AudioExportSettings(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Settings for exporting audio.

InsightsExportSettings

InsightsExportSettings(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Settings for exporting conversations to Insights <https://cloud.google.com/contact-center/insights/docs>__.

PurgeDataType

PurgeDataType(value)

Type of data we purge after retention settings triggers purge.

Values: PURGE_DATA_TYPE_UNSPECIFIED (0): Unspecified. Do not use. DIALOGFLOW_HISTORY (1): Dialogflow history. This does not include Cloud logging, which is owned by the user - not Dialogflow.

RedactionScope

RedactionScope(value)

Defines what types of data to redact.

Values: REDACTION_SCOPE_UNSPECIFIED (0): Don't redact any kind of data. REDACT_DISK_STORAGE (2): On data to be written to disk or similar devices that are capable of holding data even if power is disconnected. This includes data that are temporarily saved on disk.

RedactionStrategy

RedactionStrategy(value)

Defines how we redact data.

Values: REDACTION_STRATEGY_UNSPECIFIED (0): Do not redact. REDACT_WITH_SERVICE (1): Call redaction service to clean up the data to be persisted.

RetentionStrategy

RetentionStrategy(value)

Defines how long we retain persisted data that contains sensitive info.

Values: RETENTION_STRATEGY_UNSPECIFIED (0): Retains the persisted data with Dialogflow's internal default 365d TTLs. REMOVE_AFTER_CONVERSATION (1): Removes data when the conversation ends. If there is no [Conversation][] explicitly established, a default conversation ends when the corresponding Dialogflow session ends.