Dialogflow CX V3 API - Class Google::Cloud::Dialogflow::CX::V3::SecuritySettings (v0.23.0)

Reference documentation and code samples for the Dialogflow CX V3 API class Google::Cloud::Dialogflow::CX::V3::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.

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#audio_export_settings

def audio_export_settings() -> ::Google::Cloud::Dialogflow::CX::V3::SecuritySettings::AudioExportSettings

Returns

(::Google::Cloud::Dialogflow::CX::V3::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.

#audio_export_settings=

def audio_export_settings=(value) -> ::Google::Cloud::Dialogflow::CX::V3::SecuritySettings::AudioExportSettings

Parameter

value (::Google::Cloud::Dialogflow::CX::V3::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.

Returns

(::Google::Cloud::Dialogflow::CX::V3::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.

#deidentify_template

def deidentify_template() -> ::String

Returns

(::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/<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.

#deidentify_template=

def deidentify_template=(value) -> ::String

Parameter

value (::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/<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.

Returns

(::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/<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.

#display_name

def display_name() -> ::String

Returns

(::String) — Required. The human-readable name of the security settings, unique within the location.

#display_name=

def display_name=(value) -> ::String

Parameter

value (::String) — Required. The human-readable name of the security settings, unique within the location.

Returns

(::String) — Required. The human-readable name of the security settings, unique within the location.

#insights_export_settings

def insights_export_settings() -> ::Google::Cloud::Dialogflow::CX::V3::SecuritySettings::InsightsExportSettings

Returns

(::Google::Cloud::Dialogflow::CX::V3::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.

#insights_export_settings=

def insights_export_settings=(value) -> ::Google::Cloud::Dialogflow::CX::V3::SecuritySettings::InsightsExportSettings

Parameter

value (::Google::Cloud::Dialogflow::CX::V3::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.

Returns

(::Google::Cloud::Dialogflow::CX::V3::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.

#inspect_template

def inspect_template() -> ::String

Returns

(::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/<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.

#inspect_template=

def inspect_template=(value) -> ::String

Parameter

value (::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/<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.

Returns

(::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/<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.

#name

def name() -> ::String

Returns

(::String) — Resource name of the settings. Required for the SecuritySettingsService.UpdateSecuritySettings method. SecuritySettingsService.CreateSecuritySettings populates the name automatically. Format: projects/<Project ID>/locations/<Location ID>/securitySettings/<Security Settings ID>.

#name=

def name=(value) -> ::String

Parameter

value (::String) — Resource name of the settings. Required for the SecuritySettingsService.UpdateSecuritySettings method. SecuritySettingsService.CreateSecuritySettings populates the name automatically. Format: projects/<Project ID>/locations/<Location ID>/securitySettings/<Security Settings ID>.

Returns

(::String) — Resource name of the settings. Required for the SecuritySettingsService.UpdateSecuritySettings method. SecuritySettingsService.CreateSecuritySettings populates the name automatically. Format: projects/<Project ID>/locations/<Location ID>/securitySettings/<Security Settings ID>.

#purge_data_types

def purge_data_types() -> ::Array<::Google::Cloud::Dialogflow::CX::V3::SecuritySettings::PurgeDataType>

Returns

(::Array<::Google::Cloud::Dialogflow::CX::V3::SecuritySettings::PurgeDataType>) — List of types of data to remove when retention settings triggers purge.

#purge_data_types=

def purge_data_types=(value) -> ::Array<::Google::Cloud::Dialogflow::CX::V3::SecuritySettings::PurgeDataType>

Parameter

value (::Array<::Google::Cloud::Dialogflow::CX::V3::SecuritySettings::PurgeDataType>) — List of types of data to remove when retention settings triggers purge.

Returns

(::Array<::Google::Cloud::Dialogflow::CX::V3::SecuritySettings::PurgeDataType>) — List of types of data to remove when retention settings triggers purge.

#redaction_scope

def redaction_scope() -> ::Google::Cloud::Dialogflow::CX::V3::SecuritySettings::RedactionScope

Returns

(::Google::Cloud::Dialogflow::CX::V3::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.

#redaction_scope=

def redaction_scope=(value) -> ::Google::Cloud::Dialogflow::CX::V3::SecuritySettings::RedactionScope

Parameter

value (::Google::Cloud::Dialogflow::CX::V3::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.

Returns

(::Google::Cloud::Dialogflow::CX::V3::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.

#redaction_strategy

def redaction_strategy() -> ::Google::Cloud::Dialogflow::CX::V3::SecuritySettings::RedactionStrategy

Returns

(::Google::Cloud::Dialogflow::CX::V3::SecuritySettings::RedactionStrategy) — Strategy that defines how we do redaction.

#redaction_strategy=

def redaction_strategy=(value) -> ::Google::Cloud::Dialogflow::CX::V3::SecuritySettings::RedactionStrategy

Parameter

value (::Google::Cloud::Dialogflow::CX::V3::SecuritySettings::RedactionStrategy) — Strategy that defines how we do redaction.

Returns

(::Google::Cloud::Dialogflow::CX::V3::SecuritySettings::RedactionStrategy) — Strategy that defines how we do redaction.

#retention_strategy

def retention_strategy() -> ::Google::Cloud::Dialogflow::CX::V3::SecuritySettings::RetentionStrategy

Returns

(::Google::Cloud::Dialogflow::CX::V3::SecuritySettings::RetentionStrategy) — Specifies the retention behavior defined by SecuritySettings.RetentionStrategy.

#retention_strategy=

def retention_strategy=(value) -> ::Google::Cloud::Dialogflow::CX::V3::SecuritySettings::RetentionStrategy

Parameter

value (::Google::Cloud::Dialogflow::CX::V3::SecuritySettings::RetentionStrategy) — Specifies the retention behavior defined by SecuritySettings.RetentionStrategy.

Returns

(::Google::Cloud::Dialogflow::CX::V3::SecuritySettings::RetentionStrategy) — Specifies the retention behavior defined by SecuritySettings.RetentionStrategy.

#retention_window_days

def retention_window_days() -> ::Integer

Returns

(::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.

#retention_window_days=

def retention_window_days=(value) -> ::Integer

Parameter

value (::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.

Returns

(::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.