Package com.google.cloud.dialogflow.cx.v3

Interface SecuritySettingsOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    SecuritySettings, SecuritySettings.Builder
    public interface SecuritySettingsOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getName

        String getName()
         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>`.
        string name = 1;
        Returns:
        The name.

      • getNameBytes

        com.google.protobuf.ByteString getNameBytes()
         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>`.
        string name = 1;
        Returns:
        The bytes for name.

      • getDisplayName

        String getDisplayName()
         Required. The human-readable name of the security settings, unique within
 the location.
        string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        The displayName.

      • getDisplayNameBytes

        com.google.protobuf.ByteString getDisplayNameBytes()
         Required. The human-readable name of the security settings, unique within
 the location.
        string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        The bytes for displayName.

      • getRedactionStrategyValue

        int getRedactionStrategyValue()
         Strategy that defines how we do redaction.
        .google.cloud.dialogflow.cx.v3.SecuritySettings.RedactionStrategy redaction_strategy = 3;
        Returns:
        The enum numeric value on the wire for redactionStrategy.

      • getRedactionStrategy

        SecuritySettings.RedactionStrategy getRedactionStrategy()
         Strategy that defines how we do redaction.
        .google.cloud.dialogflow.cx.v3.SecuritySettings.RedactionStrategy redaction_strategy = 3;
        Returns:
        The redactionStrategy.

      • getRedactionScopeValue

        int getRedactionScopeValue()
         Defines the data for which Dialogflow applies redaction. Dialogflow does
 not redact data that it does not have access to – for example, Cloud
 logging.
        .google.cloud.dialogflow.cx.v3.SecuritySettings.RedactionScope redaction_scope = 4;
        Returns:
        The enum numeric value on the wire for redactionScope.

      • getRedactionScope

        SecuritySettings.RedactionScope getRedactionScope()
         Defines the data for which Dialogflow applies redaction. Dialogflow does
 not redact data that it does not have access to – for example, Cloud
 logging.
        .google.cloud.dialogflow.cx.v3.SecuritySettings.RedactionScope redaction_scope = 4;
        Returns:
        The redactionScope.

      • getInspectTemplate

        String getInspectTemplate()
         [DLP](https://cloud.google.com/dlp/docs) 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`.
        string inspect_template = 9 [(.google.api.resource_reference) = { ... }
        Returns:
        The inspectTemplate.

      • getInspectTemplateBytes

        com.google.protobuf.ByteString getInspectTemplateBytes()
         [DLP](https://cloud.google.com/dlp/docs) 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`.
        string inspect_template = 9 [(.google.api.resource_reference) = { ... }
        Returns:
        The bytes for inspectTemplate.

      • getDeidentifyTemplate

        String getDeidentifyTemplate()
         [DLP](https://cloud.google.com/dlp/docs) 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`.
        string deidentify_template = 17 [(.google.api.resource_reference) = { ... }
        Returns:
        The deidentifyTemplate.

      • getDeidentifyTemplateBytes

        com.google.protobuf.ByteString getDeidentifyTemplateBytes()
         [DLP](https://cloud.google.com/dlp/docs) 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`.
        string deidentify_template = 17 [(.google.api.resource_reference) = { ... }
        Returns:
        The bytes for deidentifyTemplate.

      • hasRetentionWindowDays

        boolean hasRetentionWindowDays()
         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.
        int32 retention_window_days = 6;
        Returns:
        Whether the retentionWindowDays field is set.

      • getRetentionWindowDays

        int getRetentionWindowDays()
         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.
        int32 retention_window_days = 6;
        Returns:
        The retentionWindowDays.

      • hasRetentionStrategy

        boolean hasRetentionStrategy()
         Specifies the retention behavior defined by
 [SecuritySettings.RetentionStrategy][google.cloud.dialogflow.cx.v3.SecuritySettings.RetentionStrategy].
        .google.cloud.dialogflow.cx.v3.SecuritySettings.RetentionStrategy retention_strategy = 7;
        Returns:
        Whether the retentionStrategy field is set.

      • getRetentionStrategyValue

        int getRetentionStrategyValue()
         Specifies the retention behavior defined by
 [SecuritySettings.RetentionStrategy][google.cloud.dialogflow.cx.v3.SecuritySettings.RetentionStrategy].
        .google.cloud.dialogflow.cx.v3.SecuritySettings.RetentionStrategy retention_strategy = 7;
        Returns:
        The enum numeric value on the wire for retentionStrategy.

      • getRetentionStrategy

        SecuritySettings.RetentionStrategy getRetentionStrategy()
         Specifies the retention behavior defined by
 [SecuritySettings.RetentionStrategy][google.cloud.dialogflow.cx.v3.SecuritySettings.RetentionStrategy].
        .google.cloud.dialogflow.cx.v3.SecuritySettings.RetentionStrategy retention_strategy = 7;
        Returns:
        The retentionStrategy.

      • getPurgeDataTypesList

        List<SecuritySettings.PurgeDataType> getPurgeDataTypesList()
         List of types of data to remove when retention settings triggers purge.
        repeated .google.cloud.dialogflow.cx.v3.SecuritySettings.PurgeDataType purge_data_types = 8;
        Returns:
        A list containing the purgeDataTypes.

      • getPurgeDataTypesCount

        int getPurgeDataTypesCount()
         List of types of data to remove when retention settings triggers purge.
        repeated .google.cloud.dialogflow.cx.v3.SecuritySettings.PurgeDataType purge_data_types = 8;
        Returns:
        The count of purgeDataTypes.

      • getPurgeDataTypes

        SecuritySettings.PurgeDataType getPurgeDataTypes​(int index)
         List of types of data to remove when retention settings triggers purge.
        repeated .google.cloud.dialogflow.cx.v3.SecuritySettings.PurgeDataType purge_data_types = 8;
        Parameters:
        index - The index of the element to return.
        Returns:
        The purgeDataTypes at the given index.

      • getPurgeDataTypesValueList

        List<Integer> getPurgeDataTypesValueList()
         List of types of data to remove when retention settings triggers purge.
        repeated .google.cloud.dialogflow.cx.v3.SecuritySettings.PurgeDataType purge_data_types = 8;
        Returns:
        A list containing the enum numeric values on the wire for purgeDataTypes.

      • getPurgeDataTypesValue

        int getPurgeDataTypesValue​(int index)
         List of types of data to remove when retention settings triggers purge.
        repeated .google.cloud.dialogflow.cx.v3.SecuritySettings.PurgeDataType purge_data_types = 8;
        Parameters:
        index - The index of the value to return.
        Returns:
        The enum numeric value on the wire of purgeDataTypes at the given index.

      • hasAudioExportSettings

        boolean hasAudioExportSettings()
         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].
        .google.cloud.dialogflow.cx.v3.SecuritySettings.AudioExportSettings audio_export_settings = 12;
        Returns:
        Whether the audioExportSettings field is set.

      • getAudioExportSettings

        SecuritySettings.AudioExportSettings getAudioExportSettings()
         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].
        .google.cloud.dialogflow.cx.v3.SecuritySettings.AudioExportSettings audio_export_settings = 12;
        Returns:
        The audioExportSettings.

      • getAudioExportSettingsOrBuilder

        SecuritySettings.AudioExportSettingsOrBuilder getAudioExportSettingsOrBuilder()
         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].
        .google.cloud.dialogflow.cx.v3.SecuritySettings.AudioExportSettings audio_export_settings = 12;

      • hasInsightsExportSettings

        boolean hasInsightsExportSettings()
         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.
        .google.cloud.dialogflow.cx.v3.SecuritySettings.InsightsExportSettings insights_export_settings = 13;
        Returns:
        Whether the insightsExportSettings field is set.

      • getInsightsExportSettings

        SecuritySettings.InsightsExportSettings getInsightsExportSettings()
         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.
        .google.cloud.dialogflow.cx.v3.SecuritySettings.InsightsExportSettings insights_export_settings = 13;
        Returns:
        The insightsExportSettings.

      • getInsightsExportSettingsOrBuilder

        SecuritySettings.InsightsExportSettingsOrBuilder getInsightsExportSettingsOrBuilder()
         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.
        .google.cloud.dialogflow.cx.v3.SecuritySettings.InsightsExportSettings insights_export_settings = 13;