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

Inherits:
Object
  • Object
show all
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: AudioExportSettings, InsightsExportSettings

Instance Attribute Summary collapse

Instance Attribute Details

#audio_export_settings ⇒ ::Google::Cloud::Dialogflow::CX::V3::SecuritySettings::AudioExportSettings

Returns 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 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][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 or Sessions.StreamingDetectIntent.



208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/security_settings.rb', line 208

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

  # Settings for exporting audio.
  # @!attribute [rw] gcs_bucket
  #   @return [::String]
  #     Cloud Storage bucket to export audio record to.
  #     Setting this field would grant the Storage Object Creator role to
  #     the Dialogflow Service Agent.
  #     API caller that tries to modify this field should have the permission of
  #     storage.buckets.setIamPolicy.
  # @!attribute [rw] audio_export_pattern
  #   @return [::String]
  #     Filename pattern for exported audio.
  # @!attribute [rw] enable_audio_redaction
  #   @return [::Boolean]
  #     Enable audio redaction if it is true.
  # @!attribute [rw] audio_format
  #   @return [::Google::Cloud::Dialogflow::CX::V3::SecuritySettings::AudioExportSettings::AudioFormat]
  #     File format for exported audio file. Currently only in telephony
  #     recordings.
  class AudioExportSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # File format for exported audio file. Currently only in telephony
    # recordings.
    module AudioFormat
      # Unspecified. Do not use.
      AUDIO_FORMAT_UNSPECIFIED = 0

      # G.711 mu-law PCM with 8kHz sample rate.
      MULAW = 1

      # MP3 file format.
      MP3 = 2

      # OGG Vorbis.
      OGG = 3
    end
  end

  # 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

#deidentify_template ⇒ ::String

Returns 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 [email protected]) 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 [email protected]) 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.



208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/security_settings.rb', line 208

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

  # Settings for exporting audio.
  # @!attribute [rw] gcs_bucket
  #   @return [::String]
  #     Cloud Storage bucket to export audio record to.
  #     Setting this field would grant the Storage Object Creator role to
  #     the Dialogflow Service Agent.
  #     API caller that tries to modify this field should have the permission of
  #     storage.buckets.setIamPolicy.
  # @!attribute [rw] audio_export_pattern
  #   @return [::String]
  #     Filename pattern for exported audio.
  # @!attribute [rw] enable_audio_redaction
  #   @return [::Boolean]
  #     Enable audio redaction if it is true.
  # @!attribute [rw] audio_format
  #   @return [::Google::Cloud::Dialogflow::CX::V3::SecuritySettings::AudioExportSettings::AudioFormat]
  #     File format for exported audio file. Currently only in telephony
  #     recordings.
  class AudioExportSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # File format for exported audio file. Currently only in telephony
    # recordings.
    module AudioFormat
      # Unspecified. Do not use.
      AUDIO_FORMAT_UNSPECIFIED = 0

      # G.711 mu-law PCM with 8kHz sample rate.
      MULAW = 1

      # MP3 file format.
      MP3 = 2

      # OGG Vorbis.
      OGG = 3
    end
  end

  # 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

Returns 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.



208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/security_settings.rb', line 208

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

  # Settings for exporting audio.
  # @!attribute [rw] gcs_bucket
  #   @return [::String]
  #     Cloud Storage bucket to export audio record to.
  #     Setting this field would grant the Storage Object Creator role to
  #     the Dialogflow Service Agent.
  #     API caller that tries to modify this field should have the permission of
  #     storage.buckets.setIamPolicy.
  # @!attribute [rw] audio_export_pattern
  #   @return [::String]
  #     Filename pattern for exported audio.
  # @!attribute [rw] enable_audio_redaction
  #   @return [::Boolean]
  #     Enable audio redaction if it is true.
  # @!attribute [rw] audio_format
  #   @return [::Google::Cloud::Dialogflow::CX::V3::SecuritySettings::AudioExportSettings::AudioFormat]
  #     File format for exported audio file. Currently only in telephony
  #     recordings.
  class AudioExportSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # File format for exported audio file. Currently only in telephony
    # recordings.
    module AudioFormat
      # Unspecified. Do not use.
      AUDIO_FORMAT_UNSPECIFIED = 0

      # G.711 mu-law PCM with 8kHz sample rate.
      MULAW = 1

      # MP3 file format.
      MP3 = 2

      # OGG Vorbis.
      OGG = 3
    end
  end

  # 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

Returns 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.

Returns:



208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/security_settings.rb', line 208

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

  # Settings for exporting audio.
  # @!attribute [rw] gcs_bucket
  #   @return [::String]
  #     Cloud Storage bucket to export audio record to.
  #     Setting this field would grant the Storage Object Creator role to
  #     the Dialogflow Service Agent.
  #     API caller that tries to modify this field should have the permission of
  #     storage.buckets.setIamPolicy.
  # @!attribute [rw] audio_export_pattern
  #   @return [::String]
  #     Filename pattern for exported audio.
  # @!attribute [rw] enable_audio_redaction
  #   @return [::Boolean]
  #     Enable audio redaction if it is true.
  # @!attribute [rw] audio_format
  #   @return [::Google::Cloud::Dialogflow::CX::V3::SecuritySettings::AudioExportSettings::AudioFormat]
  #     File format for exported audio file. Currently only in telephony
  #     recordings.
  class AudioExportSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # File format for exported audio file. Currently only in telephony
    # recordings.
    module AudioFormat
      # Unspecified. Do not use.
      AUDIO_FORMAT_UNSPECIFIED = 0

      # G.711 mu-law PCM with 8kHz sample rate.
      MULAW = 1

      # MP3 file format.
      MP3 = 2

      # OGG Vorbis.
      OGG = 3
    end
  end

  # 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

Returns 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 [email protected]) 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 [email protected]) 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.



208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/security_settings.rb', line 208

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

  # Settings for exporting audio.
  # @!attribute [rw] gcs_bucket
  #   @return [::String]
  #     Cloud Storage bucket to export audio record to.
  #     Setting this field would grant the Storage Object Creator role to
  #     the Dialogflow Service Agent.
  #     API caller that tries to modify this field should have the permission of
  #     storage.buckets.setIamPolicy.
  # @!attribute [rw] audio_export_pattern
  #   @return [::String]
  #     Filename pattern for exported audio.
  # @!attribute [rw] enable_audio_redaction
  #   @return [::Boolean]
  #     Enable audio redaction if it is true.
  # @!attribute [rw] audio_format
  #   @return [::Google::Cloud::Dialogflow::CX::V3::SecuritySettings::AudioExportSettings::AudioFormat]
  #     File format for exported audio file. Currently only in telephony
  #     recordings.
  class AudioExportSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # File format for exported audio file. Currently only in telephony
    # recordings.
    module AudioFormat
      # Unspecified. Do not use.
      AUDIO_FORMAT_UNSPECIFIED = 0

      # G.711 mu-law PCM with 8kHz sample rate.
      MULAW = 1

      # MP3 file format.
      MP3 = 2

      # OGG Vorbis.
      OGG = 3
    end
  end

  # 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

Returns 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:



208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/security_settings.rb', line 208

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

  # Settings for exporting audio.
  # @!attribute [rw] gcs_bucket
  #   @return [::String]
  #     Cloud Storage bucket to export audio record to.
  #     Setting this field would grant the Storage Object Creator role to
  #     the Dialogflow Service Agent.
  #     API caller that tries to modify this field should have the permission of
  #     storage.buckets.setIamPolicy.
  # @!attribute [rw] audio_export_pattern
  #   @return [::String]
  #     Filename pattern for exported audio.
  # @!attribute [rw] enable_audio_redaction
  #   @return [::Boolean]
  #     Enable audio redaction if it is true.
  # @!attribute [rw] audio_format
  #   @return [::Google::Cloud::Dialogflow::CX::V3::SecuritySettings::AudioExportSettings::AudioFormat]
  #     File format for exported audio file. Currently only in telephony
  #     recordings.
  class AudioExportSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # File format for exported audio file. Currently only in telephony
    # recordings.
    module AudioFormat
      # Unspecified. Do not use.
      AUDIO_FORMAT_UNSPECIFIED = 0

      # G.711 mu-law PCM with 8kHz sample rate.
      MULAW = 1

      # MP3 file format.
      MP3 = 2

      # OGG Vorbis.
      OGG = 3
    end
  end

  # 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>

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

Returns:



208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/security_settings.rb', line 208

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

  # Settings for exporting audio.
  # @!attribute [rw] gcs_bucket
  #   @return [::String]
  #     Cloud Storage bucket to export audio record to.
  #     Setting this field would grant the Storage Object Creator role to
  #     the Dialogflow Service Agent.
  #     API caller that tries to modify this field should have the permission of
  #     storage.buckets.setIamPolicy.
  # @!attribute [rw] audio_export_pattern
  #   @return [::String]
  #     Filename pattern for exported audio.
  # @!attribute [rw] enable_audio_redaction
  #   @return [::Boolean]
  #     Enable audio redaction if it is true.
  # @!attribute [rw] audio_format
  #   @return [::Google::Cloud::Dialogflow::CX::V3::SecuritySettings::AudioExportSettings::AudioFormat]
  #     File format for exported audio file. Currently only in telephony
  #     recordings.
  class AudioExportSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # File format for exported audio file. Currently only in telephony
    # recordings.
    module AudioFormat
      # Unspecified. Do not use.
      AUDIO_FORMAT_UNSPECIFIED = 0

      # G.711 mu-law PCM with 8kHz sample rate.
      MULAW = 1

      # MP3 file format.
      MP3 = 2

      # OGG Vorbis.
      OGG = 3
    end
  end

  # 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

Returns 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:



208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/security_settings.rb', line 208

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

  # Settings for exporting audio.
  # @!attribute [rw] gcs_bucket
  #   @return [::String]
  #     Cloud Storage bucket to export audio record to.
  #     Setting this field would grant the Storage Object Creator role to
  #     the Dialogflow Service Agent.
  #     API caller that tries to modify this field should have the permission of
  #     storage.buckets.setIamPolicy.
  # @!attribute [rw] audio_export_pattern
  #   @return [::String]
  #     Filename pattern for exported audio.
  # @!attribute [rw] enable_audio_redaction
  #   @return [::Boolean]
  #     Enable audio redaction if it is true.
  # @!attribute [rw] audio_format
  #   @return [::Google::Cloud::Dialogflow::CX::V3::SecuritySettings::AudioExportSettings::AudioFormat]
  #     File format for exported audio file. Currently only in telephony
  #     recordings.
  class AudioExportSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # File format for exported audio file. Currently only in telephony
    # recordings.
    module AudioFormat
      # Unspecified. Do not use.
      AUDIO_FORMAT_UNSPECIFIED = 0

      # G.711 mu-law PCM with 8kHz sample rate.
      MULAW = 1

      # MP3 file format.
      MP3 = 2

      # OGG Vorbis.
      OGG = 3
    end
  end

  # 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

Returns Strategy that defines how we do redaction.

Returns:



208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/security_settings.rb', line 208

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

  # Settings for exporting audio.
  # @!attribute [rw] gcs_bucket
  #   @return [::String]
  #     Cloud Storage bucket to export audio record to.
  #     Setting this field would grant the Storage Object Creator role to
  #     the Dialogflow Service Agent.
  #     API caller that tries to modify this field should have the permission of
  #     storage.buckets.setIamPolicy.
  # @!attribute [rw] audio_export_pattern
  #   @return [::String]
  #     Filename pattern for exported audio.
  # @!attribute [rw] enable_audio_redaction
  #   @return [::Boolean]
  #     Enable audio redaction if it is true.
  # @!attribute [rw] audio_format
  #   @return [::Google::Cloud::Dialogflow::CX::V3::SecuritySettings::AudioExportSettings::AudioFormat]
  #     File format for exported audio file. Currently only in telephony
  #     recordings.
  class AudioExportSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # File format for exported audio file. Currently only in telephony
    # recordings.
    module AudioFormat
      # Unspecified. Do not use.
      AUDIO_FORMAT_UNSPECIFIED = 0

      # G.711 mu-law PCM with 8kHz sample rate.
      MULAW = 1

      # MP3 file format.
      MP3 = 2

      # OGG Vorbis.
      OGG = 3
    end
  end

  # 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

Returns 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.



208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/security_settings.rb', line 208

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

  # Settings for exporting audio.
  # @!attribute [rw] gcs_bucket
  #   @return [::String]
  #     Cloud Storage bucket to export audio record to.
  #     Setting this field would grant the Storage Object Creator role to
  #     the Dialogflow Service Agent.
  #     API caller that tries to modify this field should have the permission of
  #     storage.buckets.setIamPolicy.
  # @!attribute [rw] audio_export_pattern
  #   @return [::String]
  #     Filename pattern for exported audio.
  # @!attribute [rw] enable_audio_redaction
  #   @return [::Boolean]
  #     Enable audio redaction if it is true.
  # @!attribute [rw] audio_format
  #   @return [::Google::Cloud::Dialogflow::CX::V3::SecuritySettings::AudioExportSettings::AudioFormat]
  #     File format for exported audio file. Currently only in telephony
  #     recordings.
  class AudioExportSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # File format for exported audio file. Currently only in telephony
    # recordings.
    module AudioFormat
      # Unspecified. Do not use.
      AUDIO_FORMAT_UNSPECIFIED = 0

      # G.711 mu-law PCM with 8kHz sample rate.
      MULAW = 1

      # MP3 file format.
      MP3 = 2

      # OGG Vorbis.
      OGG = 3
    end
  end

  # 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