Interface SecuritySettingsOrBuilder (0.16.0)

public interface SecuritySettingsOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAudioExportSettings()

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

.google.cloud.dialogflow.cx.v3.SecuritySettings.AudioExportSettings audio_export_settings = 12;

Returns

Type	Description
SecuritySettings.AudioExportSettings	The audioExportSettings.

getAudioExportSettingsOrBuilder()

public abstract SecuritySettings.AudioExportSettingsOrBuilder getAudioExportSettingsOrBuilder()

.google.cloud.dialogflow.cx.v3.SecuritySettings.AudioExportSettings audio_export_settings = 12;

Returns

Type	Description
SecuritySettings.AudioExportSettingsOrBuilder

getDataRetentionCase()

public abstract SecuritySettings.DataRetentionCase getDataRetentionCase()

Returns

Type	Description
SecuritySettings.DataRetentionCase

getDeidentifyTemplate()

public abstract String 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.

string deidentify_template = 17 [(.google.api.resource_reference) = { ... }

Returns

Type	Description
String	The deidentifyTemplate.

getDeidentifyTemplateBytes()

public abstract ByteString getDeidentifyTemplateBytes()

string deidentify_template = 17 [(.google.api.resource_reference) = { ... }

Returns

Type	Description
ByteString	The bytes for deidentifyTemplate.

getDisplayName()

public abstract 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

Type	Description
String	The displayName.

getDisplayNameBytes()

public abstract 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

Type	Description
ByteString	The bytes for displayName.

getInsightsExportSettings()

public abstract SecuritySettings.InsightsExportSettings 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.

.google.cloud.dialogflow.cx.v3.SecuritySettings.InsightsExportSettings insights_export_settings = 13;

Returns

Type	Description
SecuritySettings.InsightsExportSettings	The insightsExportSettings.

getInsightsExportSettingsOrBuilder()

public abstract SecuritySettings.InsightsExportSettingsOrBuilder getInsightsExportSettingsOrBuilder()

.google.cloud.dialogflow.cx.v3.SecuritySettings.InsightsExportSettings insights_export_settings = 13;

Returns

Type	Description
SecuritySettings.InsightsExportSettingsOrBuilder

getInspectTemplate()

public abstract String 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.

string inspect_template = 9 [(.google.api.resource_reference) = { ... }

Returns

Type	Description
String	The inspectTemplate.

getInspectTemplateBytes()

public abstract ByteString getInspectTemplateBytes()

string inspect_template = 9 [(.google.api.resource_reference) = { ... }

Returns

Type	Description
ByteString	The bytes for inspectTemplate.

getName()

public abstract String 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>.

string name = 1;

Returns

Type	Description
String	The name.

getNameBytes()

public abstract ByteString getNameBytes()

string name = 1;

Returns

Type	Description
ByteString	The bytes for name.

getPurgeDataTypes(int index)

public abstract 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;

Parameter

Name	Description
index	`int` The index of the element to return.

Returns

Type	Description
SecuritySettings.PurgeDataType	The purgeDataTypes at the given index.

getPurgeDataTypesCount()

public abstract 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

Type	Description
int	The count of purgeDataTypes.

getPurgeDataTypesList()

public abstract 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

Type	Description
List<PurgeDataType>	A list containing the purgeDataTypes.

getPurgeDataTypesValue(int index)

public abstract 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;

Parameter

Name	Description
index	`int` The index of the value to return.

Returns

Type	Description
int	The enum numeric value on the wire of purgeDataTypes at the given index.

getPurgeDataTypesValueList()

public abstract 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

Type	Description
List<Integer>	A list containing the enum numeric values on the wire for purgeDataTypes.

getRedactionScope()

public abstract SecuritySettings.RedactionScope getRedactionScope()

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

.google.cloud.dialogflow.cx.v3.SecuritySettings.RedactionScope redaction_scope = 4;

Returns

Type	Description
SecuritySettings.RedactionScope	The redactionScope.

getRedactionScopeValue()

public abstract int getRedactionScopeValue()

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

.google.cloud.dialogflow.cx.v3.SecuritySettings.RedactionScope redaction_scope = 4;

Returns

Type	Description
int	The enum numeric value on the wire for redactionScope.

getRedactionStrategy()

public abstract SecuritySettings.RedactionStrategy getRedactionStrategy()

Strategy that defines how we do redaction.

.google.cloud.dialogflow.cx.v3.SecuritySettings.RedactionStrategy redaction_strategy = 3;

Returns

Type	Description
SecuritySettings.RedactionStrategy	The redactionStrategy.

getRedactionStrategyValue()

public abstract int getRedactionStrategyValue()

Strategy that defines how we do redaction.

.google.cloud.dialogflow.cx.v3.SecuritySettings.RedactionStrategy redaction_strategy = 3;

Returns

Type	Description
int	The enum numeric value on the wire for redactionStrategy.

getRetentionWindowDays()

public abstract int getRetentionWindowDays()

Retains data in interaction logging for the specified number of days. This does not apply to Cloud logging, which is owned by the user - not Dialogflow. User must set a value lower than Dialogflow's default 365d TTL (time to live). Setting a value higher than that has no effect. A missing value or setting to 0 also means we use Dialogflow's default TTL.

int32 retention_window_days = 6;

Returns

Type	Description
int	The retentionWindowDays.

hasAudioExportSettings()

public abstract boolean hasAudioExportSettings()

.google.cloud.dialogflow.cx.v3.SecuritySettings.AudioExportSettings audio_export_settings = 12;

Returns

Type	Description
boolean	Whether the audioExportSettings field is set.

hasInsightsExportSettings()

public abstract boolean hasInsightsExportSettings()

.google.cloud.dialogflow.cx.v3.SecuritySettings.InsightsExportSettings insights_export_settings = 13;

Returns

Type	Description
boolean	Whether the insightsExportSettings field is set.

hasRetentionWindowDays()

public abstract boolean hasRetentionWindowDays()

int32 retention_window_days = 6;

Returns

Type	Description
boolean	Whether the retentionWindowDays field is set.