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.v3.SecuritySettings
Static Fields
AUDIO_EXPORT_SETTINGS_FIELD_NUMBER
public static final int AUDIO_EXPORT_SETTINGS_FIELD_NUMBER
Field Value
DEIDENTIFY_TEMPLATE_FIELD_NUMBER
public static final int DEIDENTIFY_TEMPLATE_FIELD_NUMBER
Field Value
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
INSIGHTS_EXPORT_SETTINGS_FIELD_NUMBER
public static final int INSIGHTS_EXPORT_SETTINGS_FIELD_NUMBER
Field Value
INSPECT_TEMPLATE_FIELD_NUMBER
public static final int INSPECT_TEMPLATE_FIELD_NUMBER
Field Value
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value
PURGE_DATA_TYPES_FIELD_NUMBER
public static final int PURGE_DATA_TYPES_FIELD_NUMBER
Field Value
REDACTION_SCOPE_FIELD_NUMBER
public static final int REDACTION_SCOPE_FIELD_NUMBER
Field Value
REDACTION_STRATEGY_FIELD_NUMBER
public static final int REDACTION_STRATEGY_FIELD_NUMBER
Field Value
RETENTION_WINDOW_DAYS_FIELD_NUMBER
public static final int RETENTION_WINDOW_DAYS_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static SecuritySettings getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static SecuritySettings.Builder newBuilder()
Returns
newBuilder(SecuritySettings prototype)
public static SecuritySettings.Builder newBuilder(SecuritySettings prototype)
Parameter
Returns
public static SecuritySettings parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static SecuritySettings parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static SecuritySettings parseFrom(byte[] data)
Parameter
| Name |
Description |
| data |
byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static SecuritySettings parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static SecuritySettings parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static SecuritySettings parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static SecuritySettings parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static SecuritySettings parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static SecuritySettings parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static SecuritySettings parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static SecuritySettings parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static SecuritySettings parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<SecuritySettings> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
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.v3.SecuritySettings.AudioExportSettings audio_export_settings = 12;
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.v3.SecuritySettings.AudioExportSettings audio_export_settings = 12;
getDataRetentionCase()
public SecuritySettings.DataRetentionCase getDataRetentionCase()
Returns
getDefaultInstanceForType()
public SecuritySettings getDefaultInstanceForType()
Returns
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) = { ... }
| 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) = { ... }
| 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];
| 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];
| 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.v3.SecuritySettings.InsightsExportSettings insights_export_settings = 13;
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.v3.SecuritySettings.InsightsExportSettings insights_export_settings = 13;
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) = { ... }
| 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) = { ... }
| Type |
Description |
| ByteString |
The bytes for inspectTemplate.
|
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;
| 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;
getParserForType()
public Parser<SecuritySettings> getParserForType()
Returns
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.v3.SecuritySettings.PurgeDataType purge_data_types = 8;
| Name |
Description |
| index |
int
The index of the element to return.
|
Returns
getPurgeDataTypesCount()
public 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;
| 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.v3.SecuritySettings.PurgeDataType purge_data_types = 8;
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.v3.SecuritySettings.PurgeDataType purge_data_types = 8;
| 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.v3.SecuritySettings.PurgeDataType purge_data_types = 8;
| 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 \u2013 for example, Cloud
logging.
.google.cloud.dialogflow.cx.v3.SecuritySettings.RedactionScope redaction_scope = 4;
getRedactionScopeValue()
public 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;
| 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.v3.SecuritySettings.RedactionStrategy redaction_strategy = 3;
getRedactionStrategyValue()
public int getRedactionStrategyValue()
Strategy that defines how we do redaction.
.google.cloud.dialogflow.cx.v3.SecuritySettings.RedactionStrategy redaction_strategy = 3;
| Type |
Description |
| int |
The enum numeric value on the wire for redactionStrategy.
|
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 (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;
| Type |
Description |
| int |
The retentionWindowDays.
|
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
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.v3.SecuritySettings.AudioExportSettings audio_export_settings = 12;
| 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.v3.SecuritySettings.InsightsExportSettings insights_export_settings = 13;
| Type |
Description |
| boolean |
Whether the insightsExportSettings 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 (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;
| Type |
Description |
| boolean |
Whether the retentionWindowDays field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public SecuritySettings.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected SecuritySettings.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public SecuritySettings.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
