Class: Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3SecuritySettings

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/dialogflow_v3/classes.rb,
lib/google/apis/dialogflow_v3/representations.rb,
lib/google/apis/dialogflow_v3/representations.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.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDialogflowCxV3SecuritySettings

Returns a new instance of GoogleCloudDialogflowCxV3SecuritySettings.



6313
6314
6315
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 6313

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#audio_export_settingsGoogle::Apis::DialogflowV3::GoogleCloudDialogflowCxV3SecuritySettingsAudioExportSettings

Settings for exporting audio. Corresponds to the JSON property audioExportSettings



6236
6237
6238
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 6236

def audio_export_settings
  @audio_export_settings
end

#deidentify_templateString

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//locations// deidentifyTemplates/ OR organizations//locations//deidentifyTemplates/ Note: deidentify_template must be located in the same region as the SecuritySettings. Corresponds to the JSON property deidentifyTemplate

Returns:

  • (String)


6250
6251
6252
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 6250

def deidentify_template
  @deidentify_template
end

#display_nameString

Required. The human-readable name of the security settings, unique within the location. Corresponds to the JSON property displayName

Returns:

  • (String)


6256
6257
6258
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 6256

def display_name
  @display_name
end

#insights_export_settingsGoogle::Apis::DialogflowV3::GoogleCloudDialogflowCxV3SecuritySettingsInsightsExportSettings

Settings for exporting conversations to Insights. Corresponds to the JSON property insightsExportSettings



6262
6263
6264
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 6262

def insights_export_settings
  @insights_export_settings
end

#inspect_templateString

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//locations// inspectTemplates/ OR organizations//locations//inspectTemplates/ Note: inspect_template must be located in the same region as the SecuritySettings. Corresponds to the JSON property inspectTemplate

Returns:

  • (String)


6274
6275
6276
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 6274

def inspect_template
  @inspect_template
end

#nameString

Resource name of the settings. Required for the SecuritySettingsService. UpdateSecuritySettings method. SecuritySettingsService.CreateSecuritySettings populates the name automatically. Format: projects//locations// securitySettings/. Corresponds to the JSON property name

Returns:

  • (String)


6282
6283
6284
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 6282

def name
  @name
end

#purge_data_typesArray<String>

List of types of data to remove when retention settings triggers purge. Corresponds to the JSON property purgeDataTypes

Returns:

  • (Array<String>)


6287
6288
6289
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 6287

def purge_data_types
  @purge_data_types
end

#redaction_scopeString

Defines the data for which Dialogflow applies redaction. Dialogflow does not redact data that it does not have access to – for example, Cloud logging. Corresponds to the JSON property redactionScope

Returns:

  • (String)


6293
6294
6295
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 6293

def redaction_scope
  @redaction_scope
end

#redaction_strategyString

Strategy that defines how we do redaction. Corresponds to the JSON property redactionStrategy

Returns:

  • (String)


6298
6299
6300
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 6298

def redaction_strategy
  @redaction_strategy
end

#retention_strategyString

Specifies the retention behavior defined by SecuritySettings.RetentionStrategy. Corresponds to the JSON property retentionStrategy

Returns:

  • (String)


6303
6304
6305
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 6303

def retention_strategy
  @retention_strategy
end

#retention_window_daysFixnum

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. Corresponds to the JSON property retentionWindowDays

Returns:

  • (Fixnum)


6311
6312
6313
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 6311

def retention_window_days
  @retention_window_days
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
6328
6329
6330
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 6318

def update!(**args)
  @audio_export_settings = args[:audio_export_settings] if args.key?(:audio_export_settings)
  @deidentify_template = args[:deidentify_template] if args.key?(:deidentify_template)
  @display_name = args[:display_name] if args.key?(:display_name)
  @insights_export_settings = args[:insights_export_settings] if args.key?(:insights_export_settings)
  @inspect_template = args[:inspect_template] if args.key?(:inspect_template)
  @name = args[:name] if args.key?(:name)
  @purge_data_types = args[:purge_data_types] if args.key?(:purge_data_types)
  @redaction_scope = args[:redaction_scope] if args.key?(:redaction_scope)
  @redaction_strategy = args[:redaction_strategy] if args.key?(:redaction_strategy)
  @retention_strategy = args[:retention_strategy] if args.key?(:retention_strategy)
  @retention_window_days = args[:retention_window_days] if args.key?(:retention_window_days)
end