Google Cloud Dialogflow Cx V3 Client - Class SecuritySettings (0.4.1)

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

Generated from protobuf message google.cloud.dialogflow.cx.v3.SecuritySettings

Namespace

Google \ Cloud \ Dialogflow \ Cx \ V3

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ name 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>.
↳ display_name string

Required. The human-readable name of the security settings, unique within the location.
↳ redaction_strategy int

Strategy that defines how we do redaction.
↳ redaction_scope int

Defines the data for which Dialogflow applies redaction. Dialogflow does not redact data that it does not have access to – for example, Cloud logging.
↳ inspect_template 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.
↳ deidentify_template 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.
↳ retention_window_days int

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. When data retention configuration is changed, it only applies to the data created after the change; the TTL of existing data created before the change stays intact.
↳ retention_strategy int

Specifies the retention behavior defined by SecuritySettings.RetentionStrategy.
↳ purge_data_types array

List of types of data to remove when retention settings triggers purge.
↳ audio_export_settings 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.
↳ insights_export_settings 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.

getName

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
Type Description
string

setName

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

Parameter
Name Description
var string
Returns
Type Description
$this

getDisplayName

Required. The human-readable name of the security settings, unique within the location.

Returns
Type Description
string

setDisplayName

Required. The human-readable name of the security settings, unique within the location.

Parameter
Name Description
var string
Returns
Type Description
$this

getRedactionStrategy

Strategy that defines how we do redaction.

Returns
Type Description
int

setRedactionStrategy

Strategy that defines how we do redaction.

Parameter
Name Description
var int
Returns
Type Description
$this

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.

Returns
Type Description
int

setRedactionScope

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

Parameter
Name Description
var int
Returns
Type Description
$this

getInspectTemplate

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
Type Description
string

setInspectTemplate

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.

Parameter
Name Description
var string
Returns
Type Description
$this

getDeidentifyTemplate

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
Type Description
string

setDeidentifyTemplate

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.

Parameter
Name Description
var string
Returns
Type Description
$this

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. When data retention configuration is changed, it only applies to the data created after the change; the TTL of existing data created before the change stays intact.

Returns
Type Description
int

hasRetentionWindowDays

setRetentionWindowDays

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. When data retention configuration is changed, it only applies to the data created after the change; the TTL of existing data created before the change stays intact.

Parameter
Name Description
var int
Returns
Type Description
$this

getRetentionStrategy

Specifies the retention behavior defined by SecuritySettings.RetentionStrategy.

Returns
Type Description
int

hasRetentionStrategy

setRetentionStrategy

Specifies the retention behavior defined by SecuritySettings.RetentionStrategy.

Parameter
Name Description
var int
Returns
Type Description
$this

getPurgeDataTypes

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

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setPurgeDataTypes

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

Parameter
Name Description
var int[]
Returns
Type Description
$this

getAudioExportSettings

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
Type Description
Google\Cloud\Dialogflow\Cx\V3\SecuritySettings\AudioExportSettings|null

hasAudioExportSettings

clearAudioExportSettings

setAudioExportSettings

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.

Parameter
Name Description
var Google\Cloud\Dialogflow\Cx\V3\SecuritySettings\AudioExportSettings
Returns
Type Description
$this

getInsightsExportSettings

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
Type Description
Google\Cloud\Dialogflow\Cx\V3\SecuritySettings\InsightsExportSettings|null

hasInsightsExportSettings

clearInsightsExportSettings

setInsightsExportSettings

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.

Parameter
Name Description
var Google\Cloud\Dialogflow\Cx\V3\SecuritySettings\InsightsExportSettings
Returns
Type Description
$this

getDataRetention

Returns
Type Description
string