Class SecuritySettings.Builder (0.59.0) 

public static final class SecuritySettings.Builder extends GeneratedMessageV3.Builder<SecuritySettings.Builder> implements SecuritySettingsOrBuilder

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.

Protobuf type google.cloud.dialogflow.cx.v3beta1.SecuritySettings

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > SecuritySettings.Builder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllPurgeDataTypes(Iterable<? extends SecuritySettings.PurgeDataType> values)

public SecuritySettings.Builder addAllPurgeDataTypes(Iterable<? extends SecuritySettings.PurgeDataType> values)

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

repeated .google.cloud.dialogflow.cx.v3beta1.SecuritySettings.PurgeDataType purge_data_types = 8;

Parameter
Name Description
values Iterable<? extends com.google.cloud.dialogflow.cx.v3beta1.SecuritySettings.PurgeDataType>

The purgeDataTypes to add.
Returns
Type Description
SecuritySettings.Builder

This builder for chaining.

addAllPurgeDataTypesValue(Iterable<Integer> values)

public SecuritySettings.Builder addAllPurgeDataTypesValue(Iterable<Integer> values)

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

repeated .google.cloud.dialogflow.cx.v3beta1.SecuritySettings.PurgeDataType purge_data_types = 8;

Parameter
Name Description
values Iterable<Integer>

The enum numeric values on the wire for purgeDataTypes to add.
Returns
Type Description
SecuritySettings.Builder

This builder for chaining.

addPurgeDataTypes(SecuritySettings.PurgeDataType value)

public SecuritySettings.Builder addPurgeDataTypes(SecuritySettings.PurgeDataType value)

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

repeated .google.cloud.dialogflow.cx.v3beta1.SecuritySettings.PurgeDataType purge_data_types = 8;

Parameter
Name Description
value SecuritySettings.PurgeDataType

The purgeDataTypes to add.
Returns
Type Description
SecuritySettings.Builder

This builder for chaining.

addPurgeDataTypesValue(int value)

public SecuritySettings.Builder addPurgeDataTypesValue(int value)

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

repeated .google.cloud.dialogflow.cx.v3beta1.SecuritySettings.PurgeDataType purge_data_types = 8;

Parameter
Name Description
value int

The enum numeric value on the wire for purgeDataTypes to add.
Returns
Type Description
SecuritySettings.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public SecuritySettings.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
SecuritySettings.Builder
Overrides

build()

public SecuritySettings build()
Returns
Type Description
SecuritySettings

buildPartial()

public SecuritySettings buildPartial()
Returns
Type Description
SecuritySettings

clear()

public SecuritySettings.Builder clear()
Returns
Type Description
SecuritySettings.Builder
Overrides

clearAudioExportSettings()

public SecuritySettings.Builder clearAudioExportSettings()

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.v3beta1.SecuritySettings.AudioExportSettings audio_export_settings = 12;

Returns
Type Description
SecuritySettings.Builder

clearDataRetention()

public SecuritySettings.Builder clearDataRetention()
Returns
Type Description
SecuritySettings.Builder

clearDeidentifyTemplate()

public SecuritySettings.Builder clearDeidentifyTemplate()

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

This builder for chaining.

clearDisplayName()

public SecuritySettings.Builder clearDisplayName()

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

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public SecuritySettings.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
SecuritySettings.Builder
Overrides

clearInsightsExportSettings()

public SecuritySettings.Builder clearInsightsExportSettings()

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.v3beta1.SecuritySettings.InsightsExportSettings insights_export_settings = 13;

Returns
Type Description
SecuritySettings.Builder

clearInspectTemplate()

public SecuritySettings.Builder clearInspectTemplate()

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

This builder for chaining.

clearName()

public SecuritySettings.Builder clearName()

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

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public SecuritySettings.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
SecuritySettings.Builder
Overrides

clearPurgeDataTypes()

public SecuritySettings.Builder clearPurgeDataTypes()

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

repeated .google.cloud.dialogflow.cx.v3beta1.SecuritySettings.PurgeDataType purge_data_types = 8;

Returns
Type Description
SecuritySettings.Builder

This builder for chaining.

clearRedactionScope()

public SecuritySettings.Builder clearRedactionScope()

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

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

Returns
Type Description
SecuritySettings.Builder

This builder for chaining.

clearRedactionStrategy()

public SecuritySettings.Builder clearRedactionStrategy()

Strategy that defines how we do redaction.

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

Returns
Type Description
SecuritySettings.Builder

This builder for chaining.

clearRetentionStrategy()

public SecuritySettings.Builder clearRetentionStrategy()

Specifies the retention behavior defined by SecuritySettings.RetentionStrategy.

.google.cloud.dialogflow.cx.v3beta1.SecuritySettings.RetentionStrategy retention_strategy = 7;

Returns
Type Description
SecuritySettings.Builder

This builder for chaining.

clearRetentionWindowDays()

public SecuritySettings.Builder clearRetentionWindowDays()

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

int32 retention_window_days = 6;

Returns
Type Description
SecuritySettings.Builder

This builder for chaining.

clone()

public SecuritySettings.Builder clone()
Returns
Type Description
SecuritySettings.Builder
Overrides

getAudioExportSettings()

public 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.v3beta1.SecuritySettings.AudioExportSettings audio_export_settings = 12;

Returns
Type Description
SecuritySettings.AudioExportSettings

The audioExportSettings.

getAudioExportSettingsBuilder()

public SecuritySettings.AudioExportSettings.Builder getAudioExportSettingsBuilder()

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.v3beta1.SecuritySettings.AudioExportSettings audio_export_settings = 12;

Returns
Type Description
SecuritySettings.AudioExportSettings.Builder

getAudioExportSettingsOrBuilder()

public SecuritySettings.AudioExportSettingsOrBuilder getAudioExportSettingsOrBuilder()

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.v3beta1.SecuritySettings.AudioExportSettings audio_export_settings = 12;

Returns
Type Description
SecuritySettings.AudioExportSettingsOrBuilder

getDataRetentionCase()

public SecuritySettings.DataRetentionCase getDataRetentionCase()
Returns
Type Description
SecuritySettings.DataRetentionCase

getDefaultInstanceForType()

public SecuritySettings getDefaultInstanceForType()
Returns
Type Description
SecuritySettings

getDeidentifyTemplate()

public 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 ByteString getDeidentifyTemplateBytes()

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
ByteString

The bytes for deidentifyTemplate.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getDisplayName()

public 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 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 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.v3beta1.SecuritySettings.InsightsExportSettings insights_export_settings = 13;

Returns
Type Description
SecuritySettings.InsightsExportSettings

The insightsExportSettings.

getInsightsExportSettingsBuilder()

public SecuritySettings.InsightsExportSettings.Builder getInsightsExportSettingsBuilder()

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.v3beta1.SecuritySettings.InsightsExportSettings insights_export_settings = 13;

Returns
Type Description
SecuritySettings.InsightsExportSettings.Builder

getInsightsExportSettingsOrBuilder()

public SecuritySettings.InsightsExportSettingsOrBuilder getInsightsExportSettingsOrBuilder()

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.v3beta1.SecuritySettings.InsightsExportSettings insights_export_settings = 13;

Returns
Type Description
SecuritySettings.InsightsExportSettingsOrBuilder

getInspectTemplate()

public 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 ByteString getInspectTemplateBytes()

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
ByteString

The bytes for inspectTemplate.

getName()

public 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 ByteString getNameBytes()

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
ByteString

The bytes for name.

getPurgeDataTypes(int index)

public SecuritySettings.PurgeDataType getPurgeDataTypes(int index)

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

repeated .google.cloud.dialogflow.cx.v3beta1.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 int getPurgeDataTypesCount()

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

repeated .google.cloud.dialogflow.cx.v3beta1.SecuritySettings.PurgeDataType purge_data_types = 8;

Returns
Type Description
int

The count of purgeDataTypes.

getPurgeDataTypesList()

public List<SecuritySettings.PurgeDataType> getPurgeDataTypesList()

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

repeated .google.cloud.dialogflow.cx.v3beta1.SecuritySettings.PurgeDataType purge_data_types = 8;

Returns
Type Description
List<PurgeDataType>

A list containing the purgeDataTypes.

getPurgeDataTypesValue(int index)

public int getPurgeDataTypesValue(int index)

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

repeated .google.cloud.dialogflow.cx.v3beta1.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 List<Integer> getPurgeDataTypesValueList()

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

repeated .google.cloud.dialogflow.cx.v3beta1.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 SecuritySettings.RedactionScope 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.

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

Returns
Type Description
SecuritySettings.RedactionScope

The redactionScope.

getRedactionScopeValue()

public int getRedactionScopeValue()

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

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

Returns
Type Description
int

The enum numeric value on the wire for redactionScope.

getRedactionStrategy()

public SecuritySettings.RedactionStrategy getRedactionStrategy()

Strategy that defines how we do redaction.

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

Returns
Type Description
SecuritySettings.RedactionStrategy

The redactionStrategy.

getRedactionStrategyValue()

public int getRedactionStrategyValue()

Strategy that defines how we do redaction.

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

Returns
Type Description
int

The enum numeric value on the wire for redactionStrategy.

getRetentionStrategy()

public SecuritySettings.RetentionStrategy getRetentionStrategy()

Specifies the retention behavior defined by SecuritySettings.RetentionStrategy.

.google.cloud.dialogflow.cx.v3beta1.SecuritySettings.RetentionStrategy retention_strategy = 7;

Returns
Type Description
SecuritySettings.RetentionStrategy

The retentionStrategy.

getRetentionStrategyValue()

public int getRetentionStrategyValue()

Specifies the retention behavior defined by SecuritySettings.RetentionStrategy.

.google.cloud.dialogflow.cx.v3beta1.SecuritySettings.RetentionStrategy retention_strategy = 7;

Returns
Type Description
int

The enum numeric value on the wire for retentionStrategy.

getRetentionWindowDays()

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

int32 retention_window_days = 6;

Returns
Type Description
int

The retentionWindowDays.

hasAudioExportSettings()

public boolean hasAudioExportSettings()

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.v3beta1.SecuritySettings.AudioExportSettings audio_export_settings = 12;

Returns
Type Description
boolean

Whether the audioExportSettings field is set.

hasInsightsExportSettings()

public boolean hasInsightsExportSettings()

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.v3beta1.SecuritySettings.InsightsExportSettings insights_export_settings = 13;

Returns
Type Description
boolean

Whether the insightsExportSettings field is set.

hasRetentionStrategy()

public boolean hasRetentionStrategy()

Specifies the retention behavior defined by SecuritySettings.RetentionStrategy.

.google.cloud.dialogflow.cx.v3beta1.SecuritySettings.RetentionStrategy retention_strategy = 7;

Returns
Type Description
boolean

Whether the retentionStrategy field is set.

hasRetentionWindowDays()

public boolean hasRetentionWindowDays()

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

int32 retention_window_days = 6;

Returns
Type Description
boolean

Whether the retentionWindowDays field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeAudioExportSettings(SecuritySettings.AudioExportSettings value)

public SecuritySettings.Builder mergeAudioExportSettings(SecuritySettings.AudioExportSettings value)

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.v3beta1.SecuritySettings.AudioExportSettings audio_export_settings = 12;

Parameter
Name Description
value SecuritySettings.AudioExportSettings
Returns
Type Description
SecuritySettings.Builder

mergeFrom(SecuritySettings other)

public SecuritySettings.Builder mergeFrom(SecuritySettings other)
Parameter
Name Description
other SecuritySettings
Returns
Type Description
SecuritySettings.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public SecuritySettings.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SecuritySettings.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public SecuritySettings.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
SecuritySettings.Builder
Overrides

mergeInsightsExportSettings(SecuritySettings.InsightsExportSettings value)

public SecuritySettings.Builder mergeInsightsExportSettings(SecuritySettings.InsightsExportSettings value)

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.v3beta1.SecuritySettings.InsightsExportSettings insights_export_settings = 13;

Parameter
Name Description
value SecuritySettings.InsightsExportSettings
Returns
Type Description
SecuritySettings.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final SecuritySettings.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
SecuritySettings.Builder
Overrides

setAudioExportSettings(SecuritySettings.AudioExportSettings value)

public SecuritySettings.Builder setAudioExportSettings(SecuritySettings.AudioExportSettings value)

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.v3beta1.SecuritySettings.AudioExportSettings audio_export_settings = 12;

Parameter
Name Description
value SecuritySettings.AudioExportSettings
Returns
Type Description
SecuritySettings.Builder

setAudioExportSettings(SecuritySettings.AudioExportSettings.Builder builderForValue)

public SecuritySettings.Builder setAudioExportSettings(SecuritySettings.AudioExportSettings.Builder builderForValue)

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.v3beta1.SecuritySettings.AudioExportSettings audio_export_settings = 12;

Parameter
Name Description
builderForValue SecuritySettings.AudioExportSettings.Builder
Returns
Type Description
SecuritySettings.Builder

setDeidentifyTemplate(String value)

public SecuritySettings.Builder setDeidentifyTemplate(String value)

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) = { ... }

Parameter
Name Description
value String

The deidentifyTemplate to set.
Returns
Type Description
SecuritySettings.Builder

This builder for chaining.

setDeidentifyTemplateBytes(ByteString value)

public SecuritySettings.Builder setDeidentifyTemplateBytes(ByteString value)

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) = { ... }

Parameter
Name Description
value ByteString

The bytes for deidentifyTemplate to set.
Returns
Type Description
SecuritySettings.Builder

This builder for chaining.

setDisplayName(String value)

public SecuritySettings.Builder setDisplayName(String value)

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

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value String

The displayName to set.
Returns
Type Description
SecuritySettings.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public SecuritySettings.Builder setDisplayNameBytes(ByteString value)

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

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ByteString

The bytes for displayName to set.
Returns
Type Description
SecuritySettings.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public SecuritySettings.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
SecuritySettings.Builder
Overrides

setInsightsExportSettings(SecuritySettings.InsightsExportSettings value)

public SecuritySettings.Builder setInsightsExportSettings(SecuritySettings.InsightsExportSettings value)

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.v3beta1.SecuritySettings.InsightsExportSettings insights_export_settings = 13;

Parameter
Name Description
value SecuritySettings.InsightsExportSettings
Returns
Type Description
SecuritySettings.Builder

setInsightsExportSettings(SecuritySettings.InsightsExportSettings.Builder builderForValue)

public SecuritySettings.Builder setInsightsExportSettings(SecuritySettings.InsightsExportSettings.Builder builderForValue)

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.v3beta1.SecuritySettings.InsightsExportSettings insights_export_settings = 13;

Parameter
Name Description
builderForValue SecuritySettings.InsightsExportSettings.Builder
Returns
Type Description
SecuritySettings.Builder

setInspectTemplate(String value)

public SecuritySettings.Builder setInspectTemplate(String value)

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) = { ... }

Parameter
Name Description
value String

The inspectTemplate to set.
Returns
Type Description
SecuritySettings.Builder

This builder for chaining.

setInspectTemplateBytes(ByteString value)

public SecuritySettings.Builder setInspectTemplateBytes(ByteString value)

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) = { ... }

Parameter
Name Description
value ByteString

The bytes for inspectTemplate to set.
Returns
Type Description
SecuritySettings.Builder

This builder for chaining.

setName(String value)

public SecuritySettings.Builder setName(String value)

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;

Parameter
Name Description
value String

The name to set.
Returns
Type Description
SecuritySettings.Builder

This builder for chaining.

setNameBytes(ByteString value)

public SecuritySettings.Builder setNameBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for name to set.
Returns
Type Description
SecuritySettings.Builder

This builder for chaining.

setPurgeDataTypes(int index, SecuritySettings.PurgeDataType value)

public SecuritySettings.Builder setPurgeDataTypes(int index, SecuritySettings.PurgeDataType value)

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

repeated .google.cloud.dialogflow.cx.v3beta1.SecuritySettings.PurgeDataType purge_data_types = 8;

Parameters
Name Description
index int

The index to set the value at.
value SecuritySettings.PurgeDataType

The purgeDataTypes to set.
Returns
Type Description
SecuritySettings.Builder

This builder for chaining.

setPurgeDataTypesValue(int index, int value)

public SecuritySettings.Builder setPurgeDataTypesValue(int index, int value)

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

repeated .google.cloud.dialogflow.cx.v3beta1.SecuritySettings.PurgeDataType purge_data_types = 8;

Parameters
Name Description
index int

The index to set the value at.
value int

The enum numeric value on the wire for purgeDataTypes to set.
Returns
Type Description
SecuritySettings.Builder

This builder for chaining.

setRedactionScope(SecuritySettings.RedactionScope value)

public SecuritySettings.Builder setRedactionScope(SecuritySettings.RedactionScope value)

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

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

Parameter
Name Description
value SecuritySettings.RedactionScope

The redactionScope to set.
Returns
Type Description
SecuritySettings.Builder

This builder for chaining.

setRedactionScopeValue(int value)

public SecuritySettings.Builder setRedactionScopeValue(int value)

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

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

Parameter
Name Description
value int

The enum numeric value on the wire for redactionScope to set.
Returns
Type Description
SecuritySettings.Builder

This builder for chaining.

setRedactionStrategy(SecuritySettings.RedactionStrategy value)

public SecuritySettings.Builder setRedactionStrategy(SecuritySettings.RedactionStrategy value)

Strategy that defines how we do redaction.

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

Parameter
Name Description
value SecuritySettings.RedactionStrategy

The redactionStrategy to set.
Returns
Type Description
SecuritySettings.Builder

This builder for chaining.

setRedactionStrategyValue(int value)

public SecuritySettings.Builder setRedactionStrategyValue(int value)

Strategy that defines how we do redaction.

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

Parameter
Name Description
value int

The enum numeric value on the wire for redactionStrategy to set.
Returns
Type Description
SecuritySettings.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public SecuritySettings.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
SecuritySettings.Builder
Overrides

setRetentionStrategy(SecuritySettings.RetentionStrategy value)

public SecuritySettings.Builder setRetentionStrategy(SecuritySettings.RetentionStrategy value)

Specifies the retention behavior defined by SecuritySettings.RetentionStrategy.

.google.cloud.dialogflow.cx.v3beta1.SecuritySettings.RetentionStrategy retention_strategy = 7;

Parameter
Name Description
value SecuritySettings.RetentionStrategy

The retentionStrategy to set.
Returns
Type Description
SecuritySettings.Builder

This builder for chaining.

setRetentionStrategyValue(int value)

public SecuritySettings.Builder setRetentionStrategyValue(int value)

Specifies the retention behavior defined by SecuritySettings.RetentionStrategy.

.google.cloud.dialogflow.cx.v3beta1.SecuritySettings.RetentionStrategy retention_strategy = 7;

Parameter
Name Description
value int

The enum numeric value on the wire for retentionStrategy to set.
Returns
Type Description
SecuritySettings.Builder

This builder for chaining.

setRetentionWindowDays(int value)

public SecuritySettings.Builder setRetentionWindowDays(int value)

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

int32 retention_window_days = 6;

Parameter
Name Description
value int

The retentionWindowDays to set.
Returns
Type Description
SecuritySettings.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final SecuritySettings.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
SecuritySettings.Builder
Overrides