public sealed class SecuritySettings : IMessage<SecuritySettings>, IEquatable<SecuritySettings>, IDeepCloneable<SecuritySettings>, IBufferMessage, IMessageReference documentation and code samples for the Dialogflow v3 API class SecuritySettings.
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.
Implements
IMessage<SecuritySettings>, IEquatable<SecuritySettings>, IDeepCloneable<SecuritySettings>, IBufferMessage, IMessageNamespace
Google.Cloud.Dialogflow.Cx.V3Assembly
Google.Cloud.Dialogflow.Cx.V3.dll
Constructors
SecuritySettings()
public SecuritySettings()SecuritySettings(SecuritySettings)
public SecuritySettings(SecuritySettings other)| Parameter | |
|---|---|
| Name | Description |
other | SecuritySettings |
Properties
AudioExportSettings
public SecuritySettings.Types.AudioExportSettings AudioExportSettings { get; set; }Controls audio export settings for post-conversation analytics when ingesting audio to conversations via [Participants.AnalyzeContent][] or [Participants.StreamingAnalyzeContent][].
If [retention_strategy][google.cloud.dialogflow.cx.v3.SecuritySettings.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][google.cloud.dialogflow.cx.v3.Sessions.DetectIntent] or [Sessions.StreamingDetectIntent][google.cloud.dialogflow.cx.v3.Sessions.StreamingDetectIntent].
| Property Value | |
|---|---|
| Type | Description |
SecuritySettings.Types.AudioExportSettings | |
DataRetentionCase
public SecuritySettings.DataRetentionOneofCase DataRetentionCase { get; }| Property Value | |
|---|---|
| Type | Description |
SecuritySettings.DataRetentionOneofCase | |
DeidentifyTemplate
public string DeidentifyTemplate { get; set; }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/<Project ID>/locations/<Location
ID>/deidentifyTemplates/<Template ID> OR organizations/<Organization
ID>/locations/<Location ID>/deidentifyTemplates/<Template ID>
Note: deidentify_template must be located in the same region as the
SecuritySettings.
| Property Value | |
|---|---|
| Type | Description |
String | |
DeidentifyTemplateAsDeidentifyTemplateName
public DeidentifyTemplateName DeidentifyTemplateAsDeidentifyTemplateName { get; set; }DeidentifyTemplateName-typed view over the DeidentifyTemplate resource name property.
| Property Value | |
|---|---|
| Type | Description |
DeidentifyTemplateName | |
DisplayName
public string DisplayName { get; set; }Required. The human-readable name of the security settings, unique within the location.
| Property Value | |
|---|---|
| Type | Description |
String | |
InsightsExportSettings
public SecuritySettings.Types.InsightsExportSettings InsightsExportSettings { get; set; }Controls conversation exporting settings to Insights after conversation is completed.
If [retention_strategy][google.cloud.dialogflow.cx.v3.SecuritySettings.retention_strategy] is set to REMOVE_AFTER_CONVERSATION, Insights export is disabled no matter what you configure here.
| Property Value | |
|---|---|
| Type | Description |
SecuritySettings.Types.InsightsExportSettings | |
InspectTemplate
public string InspectTemplate { get; set; }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/<Project ID>/locations/<Location ID>/inspectTemplates/<Template
ID> OR organizations/<Organization ID>/locations/<Location
ID>/inspectTemplates/<Template ID>
Note: inspect_template must be located in the same region as the
SecuritySettings.
| Property Value | |
|---|---|
| Type | Description |
String | |
InspectTemplateAsInspectTemplateName
public InspectTemplateName InspectTemplateAsInspectTemplateName { get; set; }InspectTemplateName-typed view over the InspectTemplate resource name property.
| Property Value | |
|---|---|
| Type | Description |
InspectTemplateName | |
Name
public string Name { get; set; }Resource name of the settings.
Required for the
[SecuritySettingsService.UpdateSecuritySettings][google.cloud.dialogflow.cx.v3.SecuritySettingsService.UpdateSecuritySettings]
method.
[SecuritySettingsService.CreateSecuritySettings][google.cloud.dialogflow.cx.v3.SecuritySettingsService.CreateSecuritySettings]
populates the name automatically. Format: projects/<Project
ID>/locations/<Location ID>/securitySettings/<Security Settings ID>.
| Property Value | |
|---|---|
| Type | Description |
String | |
PurgeDataTypes
public RepeatedField<SecuritySettings.Types.PurgeDataType> PurgeDataTypes { get; }List of types of data to remove when retention settings triggers purge.
| Property Value | |
|---|---|
| Type | Description |
RepeatedField<SecuritySettings.Types.PurgeDataType> | |
RedactionScope
public SecuritySettings.Types.RedactionScope RedactionScope { get; set; }Defines the data for which Dialogflow applies redaction. Dialogflow does not redact data that it does not have access to – for example, Cloud logging.
| Property Value | |
|---|---|
| Type | Description |
SecuritySettings.Types.RedactionScope | |
RedactionStrategy
public SecuritySettings.Types.RedactionStrategy RedactionStrategy { get; set; }Strategy that defines how we do redaction.
| Property Value | |
|---|---|
| Type | Description |
SecuritySettings.Types.RedactionStrategy | |
RetentionWindowDays
public int RetentionWindowDays { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
Int32 | |
SecuritySettingsName
public SecuritySettingsName SecuritySettingsName { get; set; }SecuritySettingsName-typed view over the Name resource name property.
| Property Value | |
|---|---|
| Type | Description |
SecuritySettingsName | |