Class: Google::Cloud::Dialogflow::CX::V3::SecuritySettings

Inherits:

Object

• Object
• Google::Cloud::Dialogflow::CX::V3::SecuritySettings

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/cloud/dialogflow/cx/v3/security_settings.rb

Overview

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.

Defined Under Namespace

Modules: PurgeDataType, RedactionScope, RedactionStrategy Classes: InsightsExportSettings

Instance Attribute Summary

• #deidentify_template ⇒ ::String

  DLP deidentify template name.

• #display_name ⇒ ::String

  Required.

• #insights_export_settings ⇒ ::Google::Cloud::Dialogflow::CX::V3::SecuritySettings::InsightsExportSettings

  Controls conversation exporting settings to Insights after conversation is completed.

• #inspect_template ⇒ ::String

  DLP inspect template name.

• #name ⇒ ::String

  Resource name of the settings.

• #purge_data_types ⇒ ::Array<::Google::Cloud::Dialogflow::CX::V3::SecuritySettings::PurgeDataType>

  List of types of data to remove when retention settings triggers purge.

• #redaction_scope ⇒ ::Google::Cloud::Dialogflow::CX::V3::SecuritySettings::RedactionScope

  Defines the data for which Dialogflow applies redaction.

• #redaction_strategy ⇒ ::Google::Cloud::Dialogflow::CX::V3::SecuritySettings::RedactionStrategy

  Strategy that defines how we do redaction.

• #retention_window_days ⇒ ::Integer

  Retains data in interaction logging for the specified number of days.

Instance Attribute Details

#deidentify_template ⇒ ::String

# File 'proto_docs/google/cloud/dialogflow/cx/v3/security_settings.rb', line 186

class SecuritySettings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Settings for exporting conversations to
  # [Insights](https://cloud.google.com/contact-center/insights/docs).
  # @!attribute [rw] enable_insights_export
  #   @return [::Boolean]
  #     If enabled, we will automatically exports
  #     conversations to Insights and Insights runs its analyzers.
  class InsightsExportSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Defines how we redact data.
  module RedactionStrategy
    # Do not redact.
    REDACTION_STRATEGY_UNSPECIFIED = 0

    # Call redaction service to clean up the data to be persisted.
    REDACT_WITH_SERVICE = 1
  end

  # Defines what types of data to redact.
  module RedactionScope
    # Don't redact any kind of data.
    REDACTION_SCOPE_UNSPECIFIED = 0

    # 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.
    REDACT_DISK_STORAGE = 2
  end

  # Type of data we purge after retention settings triggers purge.
  module PurgeDataType
    # Unspecified. Do not use.
    PURGE_DATA_TYPE_UNSPECIFIED = 0

    # Dialogflow history. This does not include Cloud logging, which is
    # owned by the user - not Dialogflow.
    DIALOGFLOW_HISTORY = 1
  end
end

#display_name ⇒ ::String

# File 'proto_docs/google/cloud/dialogflow/cx/v3/security_settings.rb', line 186

class SecuritySettings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Settings for exporting conversations to
  # [Insights](https://cloud.google.com/contact-center/insights/docs).
  # @!attribute [rw] enable_insights_export
  #   @return [::Boolean]
  #     If enabled, we will automatically exports
  #     conversations to Insights and Insights runs its analyzers.
  class InsightsExportSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Defines how we redact data.
  module RedactionStrategy
    # Do not redact.
    REDACTION_STRATEGY_UNSPECIFIED = 0

    # Call redaction service to clean up the data to be persisted.
    REDACT_WITH_SERVICE = 1
  end

  # Defines what types of data to redact.
  module RedactionScope
    # Don't redact any kind of data.
    REDACTION_SCOPE_UNSPECIFIED = 0

    # 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.
    REDACT_DISK_STORAGE = 2
  end

  # Type of data we purge after retention settings triggers purge.
  module PurgeDataType
    # Unspecified. Do not use.
    PURGE_DATA_TYPE_UNSPECIFIED = 0

    # Dialogflow history. This does not include Cloud logging, which is
    # owned by the user - not Dialogflow.
    DIALOGFLOW_HISTORY = 1
  end
end

#insights_export_settings ⇒ ::Google::Cloud::Dialogflow::CX::V3::SecuritySettings::InsightsExportSettings

# File 'proto_docs/google/cloud/dialogflow/cx/v3/security_settings.rb', line 186

class SecuritySettings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Settings for exporting conversations to
  # [Insights](https://cloud.google.com/contact-center/insights/docs).
  # @!attribute [rw] enable_insights_export
  #   @return [::Boolean]
  #     If enabled, we will automatically exports
  #     conversations to Insights and Insights runs its analyzers.
  class InsightsExportSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Defines how we redact data.
  module RedactionStrategy
    # Do not redact.
    REDACTION_STRATEGY_UNSPECIFIED = 0

    # Call redaction service to clean up the data to be persisted.
    REDACT_WITH_SERVICE = 1
  end

  # Defines what types of data to redact.
  module RedactionScope
    # Don't redact any kind of data.
    REDACTION_SCOPE_UNSPECIFIED = 0

    # 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.
    REDACT_DISK_STORAGE = 2
  end

  # Type of data we purge after retention settings triggers purge.
  module PurgeDataType
    # Unspecified. Do not use.
    PURGE_DATA_TYPE_UNSPECIFIED = 0

    # Dialogflow history. This does not include Cloud logging, which is
    # owned by the user - not Dialogflow.
    DIALOGFLOW_HISTORY = 1
  end
end

#inspect_template ⇒ ::String

# File 'proto_docs/google/cloud/dialogflow/cx/v3/security_settings.rb', line 186

class SecuritySettings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Settings for exporting conversations to
  # [Insights](https://cloud.google.com/contact-center/insights/docs).
  # @!attribute [rw] enable_insights_export
  #   @return [::Boolean]
  #     If enabled, we will automatically exports
  #     conversations to Insights and Insights runs its analyzers.
  class InsightsExportSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Defines how we redact data.
  module RedactionStrategy
    # Do not redact.
    REDACTION_STRATEGY_UNSPECIFIED = 0

    # Call redaction service to clean up the data to be persisted.
    REDACT_WITH_SERVICE = 1
  end

  # Defines what types of data to redact.
  module RedactionScope
    # Don't redact any kind of data.
    REDACTION_SCOPE_UNSPECIFIED = 0

    # 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.
    REDACT_DISK_STORAGE = 2
  end

  # Type of data we purge after retention settings triggers purge.
  module PurgeDataType
    # Unspecified. Do not use.
    PURGE_DATA_TYPE_UNSPECIFIED = 0

    # Dialogflow history. This does not include Cloud logging, which is
    # owned by the user - not Dialogflow.
    DIALOGFLOW_HISTORY = 1
  end
end

#name ⇒ ::String

# File 'proto_docs/google/cloud/dialogflow/cx/v3/security_settings.rb', line 186

class SecuritySettings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Settings for exporting conversations to
  # [Insights](https://cloud.google.com/contact-center/insights/docs).
  # @!attribute [rw] enable_insights_export
  #   @return [::Boolean]
  #     If enabled, we will automatically exports
  #     conversations to Insights and Insights runs its analyzers.
  class InsightsExportSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Defines how we redact data.
  module RedactionStrategy
    # Do not redact.
    REDACTION_STRATEGY_UNSPECIFIED = 0

    # Call redaction service to clean up the data to be persisted.
    REDACT_WITH_SERVICE = 1
  end

  # Defines what types of data to redact.
  module RedactionScope
    # Don't redact any kind of data.
    REDACTION_SCOPE_UNSPECIFIED = 0

    # 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.
    REDACT_DISK_STORAGE = 2
  end

  # Type of data we purge after retention settings triggers purge.
  module PurgeDataType
    # Unspecified. Do not use.
    PURGE_DATA_TYPE_UNSPECIFIED = 0

    # Dialogflow history. This does not include Cloud logging, which is
    # owned by the user - not Dialogflow.
    DIALOGFLOW_HISTORY = 1
  end
end

#purge_data_types ⇒ ::Array<::Google::Cloud::Dialogflow::CX::V3::SecuritySettings::PurgeDataType>

# File 'proto_docs/google/cloud/dialogflow/cx/v3/security_settings.rb', line 186

class SecuritySettings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Settings for exporting conversations to
  # [Insights](https://cloud.google.com/contact-center/insights/docs).
  # @!attribute [rw] enable_insights_export
  #   @return [::Boolean]
  #     If enabled, we will automatically exports
  #     conversations to Insights and Insights runs its analyzers.
  class InsightsExportSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Defines how we redact data.
  module RedactionStrategy
    # Do not redact.
    REDACTION_STRATEGY_UNSPECIFIED = 0

    # Call redaction service to clean up the data to be persisted.
    REDACT_WITH_SERVICE = 1
  end

  # Defines what types of data to redact.
  module RedactionScope
    # Don't redact any kind of data.
    REDACTION_SCOPE_UNSPECIFIED = 0

    # 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.
    REDACT_DISK_STORAGE = 2
  end

  # Type of data we purge after retention settings triggers purge.
  module PurgeDataType
    # Unspecified. Do not use.
    PURGE_DATA_TYPE_UNSPECIFIED = 0

    # Dialogflow history. This does not include Cloud logging, which is
    # owned by the user - not Dialogflow.
    DIALOGFLOW_HISTORY = 1
  end
end

#redaction_scope ⇒ ::Google::Cloud::Dialogflow::CX::V3::SecuritySettings::RedactionScope

# File 'proto_docs/google/cloud/dialogflow/cx/v3/security_settings.rb', line 186

class SecuritySettings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Settings for exporting conversations to
  # [Insights](https://cloud.google.com/contact-center/insights/docs).
  # @!attribute [rw] enable_insights_export
  #   @return [::Boolean]
  #     If enabled, we will automatically exports
  #     conversations to Insights and Insights runs its analyzers.
  class InsightsExportSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Defines how we redact data.
  module RedactionStrategy
    # Do not redact.
    REDACTION_STRATEGY_UNSPECIFIED = 0

    # Call redaction service to clean up the data to be persisted.
    REDACT_WITH_SERVICE = 1
  end

  # Defines what types of data to redact.
  module RedactionScope
    # Don't redact any kind of data.
    REDACTION_SCOPE_UNSPECIFIED = 0

    # 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.
    REDACT_DISK_STORAGE = 2
  end

  # Type of data we purge after retention settings triggers purge.
  module PurgeDataType
    # Unspecified. Do not use.
    PURGE_DATA_TYPE_UNSPECIFIED = 0

    # Dialogflow history. This does not include Cloud logging, which is
    # owned by the user - not Dialogflow.
    DIALOGFLOW_HISTORY = 1
  end
end

#redaction_strategy ⇒ ::Google::Cloud::Dialogflow::CX::V3::SecuritySettings::RedactionStrategy

# File 'proto_docs/google/cloud/dialogflow/cx/v3/security_settings.rb', line 186

class SecuritySettings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Settings for exporting conversations to
  # [Insights](https://cloud.google.com/contact-center/insights/docs).
  # @!attribute [rw] enable_insights_export
  #   @return [::Boolean]
  #     If enabled, we will automatically exports
  #     conversations to Insights and Insights runs its analyzers.
  class InsightsExportSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Defines how we redact data.
  module RedactionStrategy
    # Do not redact.
    REDACTION_STRATEGY_UNSPECIFIED = 0

    # Call redaction service to clean up the data to be persisted.
    REDACT_WITH_SERVICE = 1
  end

  # Defines what types of data to redact.
  module RedactionScope
    # Don't redact any kind of data.
    REDACTION_SCOPE_UNSPECIFIED = 0

    # 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.
    REDACT_DISK_STORAGE = 2
  end

  # Type of data we purge after retention settings triggers purge.
  module PurgeDataType
    # Unspecified. Do not use.
    PURGE_DATA_TYPE_UNSPECIFIED = 0

    # Dialogflow history. This does not include Cloud logging, which is
    # owned by the user - not Dialogflow.
    DIALOGFLOW_HISTORY = 1
  end
end

#retention_window_days ⇒ ::Integer

# File 'proto_docs/google/cloud/dialogflow/cx/v3/security_settings.rb', line 186

class SecuritySettings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Settings for exporting conversations to
  # [Insights](https://cloud.google.com/contact-center/insights/docs).
  # @!attribute [rw] enable_insights_export
  #   @return [::Boolean]
  #     If enabled, we will automatically exports
  #     conversations to Insights and Insights runs its analyzers.
  class InsightsExportSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Defines how we redact data.
  module RedactionStrategy
    # Do not redact.
    REDACTION_STRATEGY_UNSPECIFIED = 0

    # Call redaction service to clean up the data to be persisted.
    REDACT_WITH_SERVICE = 1
  end

  # Defines what types of data to redact.
  module RedactionScope
    # Don't redact any kind of data.
    REDACTION_SCOPE_UNSPECIFIED = 0

    # 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.
    REDACT_DISK_STORAGE = 2
  end

  # Type of data we purge after retention settings triggers purge.
  module PurgeDataType
    # Unspecified. Do not use.
    PURGE_DATA_TYPE_UNSPECIFIED = 0

    # Dialogflow history. This does not include Cloud logging, which is
    # owned by the user - not Dialogflow.
    DIALOGFLOW_HISTORY = 1
  end
end