Class SecuritySettings (0.58.0) 

public final class SecuritySettings extends GeneratedMessageV3 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<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > SecuritySettings

Static Fields

AUDIO_EXPORT_SETTINGS_FIELD_NUMBER

public static final int AUDIO_EXPORT_SETTINGS_FIELD_NUMBER
Field Value
Type Description
int

DEIDENTIFY_TEMPLATE_FIELD_NUMBER

public static final int DEIDENTIFY_TEMPLATE_FIELD_NUMBER
Field Value
Type Description
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

INSIGHTS_EXPORT_SETTINGS_FIELD_NUMBER

public static final int INSIGHTS_EXPORT_SETTINGS_FIELD_NUMBER
Field Value
Type Description
int

INSPECT_TEMPLATE_FIELD_NUMBER

public static final int INSPECT_TEMPLATE_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

PURGE_DATA_TYPES_FIELD_NUMBER

public static final int PURGE_DATA_TYPES_FIELD_NUMBER
Field Value
Type Description
int

REDACTION_SCOPE_FIELD_NUMBER

public static final int REDACTION_SCOPE_FIELD_NUMBER
Field Value
Type Description
int

REDACTION_STRATEGY_FIELD_NUMBER

public static final int REDACTION_STRATEGY_FIELD_NUMBER
Field Value
Type Description
int

RETENTION_STRATEGY_FIELD_NUMBER

public static final int RETENTION_STRATEGY_FIELD_NUMBER
Field Value
Type Description
int

RETENTION_WINDOW_DAYS_FIELD_NUMBER

public static final int RETENTION_WINDOW_DAYS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static SecuritySettings getDefaultInstance()
Returns
Type Description
SecuritySettings

getDescriptor()

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

newBuilder()

public static SecuritySettings.Builder newBuilder()
Returns
Type Description
SecuritySettings.Builder

newBuilder(SecuritySettings prototype)

public static SecuritySettings.Builder newBuilder(SecuritySettings prototype)
Parameter
Name Description
prototype SecuritySettings
Returns
Type Description
SecuritySettings.Builder

parseDelimitedFrom(InputStream input)

public static SecuritySettings parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SecuritySettings
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SecuritySettings parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SecuritySettings
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static SecuritySettings parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
SecuritySettings
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SecuritySettings parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SecuritySettings
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SecuritySettings parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
SecuritySettings
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SecuritySettings parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SecuritySettings
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SecuritySettings parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
SecuritySettings
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SecuritySettings parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SecuritySettings
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static SecuritySettings parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SecuritySettings
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SecuritySettings parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SecuritySettings
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static SecuritySettings parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
SecuritySettings
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SecuritySettings parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SecuritySettings
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<SecuritySettings> parser()
Returns
Type Description
Parser<SecuritySettings>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
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.

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.

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.

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.

getParserForType()

public Parser<SecuritySettings> getParserForType()
Returns
Type Description
Parser<SecuritySettings>
Overrides

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.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SecuritySettings.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
SecuritySettings.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException