Package com.google.cloud.dialogflow.cx.v3beta1

Class SecuritySettings.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<SecuritySettings.Builder>
com.google.cloud.dialogflow.cx.v3beta1.SecuritySettings.Builder
All Implemented Interfaces:
SecuritySettingsOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
SecuritySettings
public static final class SecuritySettings.Builder extends com.google.protobuf.GeneratedMessage.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

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<SecuritySettings.Builder>

    • clear

      public SecuritySettings.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<SecuritySettings.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<SecuritySettings.Builder>

    • getDefaultInstanceForType

      public SecuritySettings getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

      public SecuritySettings build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public SecuritySettings buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • mergeFrom

      public SecuritySettings.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<SecuritySettings.Builder>

    • mergeFrom

      public SecuritySettings.Builder mergeFrom(SecuritySettings other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<SecuritySettings.Builder>

    • mergeFrom

      public SecuritySettings.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<SecuritySettings.Builder>
      Throws:
      IOException

    • getDataRetentionCase

      public SecuritySettings.DataRetentionCase getDataRetentionCase()
      Specified by:
      getDataRetentionCase in interface SecuritySettingsOrBuilder

    • clearDataRetention

      public SecuritySettings.Builder clearDataRetention()

    • getName

      public String getName()
       Resource name of the settings.
 Required for the
 [SecuritySettingsService.UpdateSecuritySettings][google.cloud.dialogflow.cx.v3beta1.SecuritySettingsService.UpdateSecuritySettings]
 method.
 [SecuritySettingsService.CreateSecuritySettings][google.cloud.dialogflow.cx.v3beta1.SecuritySettingsService.CreateSecuritySettings]
 populates the name automatically. Format:
 `projects/<ProjectID>/locations/<LocationID>/securitySettings/<SecuritySettingsID>`.
      string name = 1;
      Specified by:
      getName in interface SecuritySettingsOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       Resource name of the settings.
 Required for the
 [SecuritySettingsService.UpdateSecuritySettings][google.cloud.dialogflow.cx.v3beta1.SecuritySettingsService.UpdateSecuritySettings]
 method.
 [SecuritySettingsService.CreateSecuritySettings][google.cloud.dialogflow.cx.v3beta1.SecuritySettingsService.CreateSecuritySettings]
 populates the name automatically. Format:
 `projects/<ProjectID>/locations/<LocationID>/securitySettings/<SecuritySettingsID>`.
      string name = 1;
      Specified by:
      getNameBytes in interface SecuritySettingsOrBuilder
      Returns:
      The bytes for name.

    • setName

      public SecuritySettings.Builder setName(String value)
       Resource name of the settings.
 Required for the
 [SecuritySettingsService.UpdateSecuritySettings][google.cloud.dialogflow.cx.v3beta1.SecuritySettingsService.UpdateSecuritySettings]
 method.
 [SecuritySettingsService.CreateSecuritySettings][google.cloud.dialogflow.cx.v3beta1.SecuritySettingsService.CreateSecuritySettings]
 populates the name automatically. Format:
 `projects/<ProjectID>/locations/<LocationID>/securitySettings/<SecuritySettingsID>`.
      string name = 1;
      Parameters:
      value - The name to set.
      Returns:
      This builder for chaining.

    • clearName

      public SecuritySettings.Builder clearName()
       Resource name of the settings.
 Required for the
 [SecuritySettingsService.UpdateSecuritySettings][google.cloud.dialogflow.cx.v3beta1.SecuritySettingsService.UpdateSecuritySettings]
 method.
 [SecuritySettingsService.CreateSecuritySettings][google.cloud.dialogflow.cx.v3beta1.SecuritySettingsService.CreateSecuritySettings]
 populates the name automatically. Format:
 `projects/<ProjectID>/locations/<LocationID>/securitySettings/<SecuritySettingsID>`.
      string name = 1;
      Returns:
      This builder for chaining.

    • setNameBytes

      public SecuritySettings.Builder setNameBytes(com.google.protobuf.ByteString value)
       Resource name of the settings.
 Required for the
 [SecuritySettingsService.UpdateSecuritySettings][google.cloud.dialogflow.cx.v3beta1.SecuritySettingsService.UpdateSecuritySettings]
 method.
 [SecuritySettingsService.CreateSecuritySettings][google.cloud.dialogflow.cx.v3beta1.SecuritySettingsService.CreateSecuritySettings]
 populates the name automatically. Format:
 `projects/<ProjectID>/locations/<LocationID>/securitySettings/<SecuritySettingsID>`.
      string name = 1;
      Parameters:
      value - The bytes for name to set.
      Returns:
      This builder for chaining.

    • 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];
      Specified by:
      getDisplayName in interface SecuritySettingsOrBuilder
      Returns:
      The displayName.

    • getDisplayNameBytes

      public com.google.protobuf.ByteString getDisplayNameBytes()
       Required. The human-readable name of the security settings, unique within
 the location.
      string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getDisplayNameBytes in interface SecuritySettingsOrBuilder
      Returns:
      The bytes for displayName.

    • setDisplayName

      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];
      Parameters:
      value - The displayName to set.
      Returns:
      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:
      This builder for chaining.

    • setDisplayNameBytes

      public SecuritySettings.Builder setDisplayNameBytes(com.google.protobuf.ByteString value)
       Required. The human-readable name of the security settings, unique within
 the location.
      string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      value - The bytes for displayName to set.
      Returns:
      This builder for chaining.

    • getRedactionStrategyValue

      public int getRedactionStrategyValue()
       Strategy that defines how we do redaction.
      .google.cloud.dialogflow.cx.v3beta1.SecuritySettings.RedactionStrategy redaction_strategy = 3;
      Specified by:
      getRedactionStrategyValue in interface SecuritySettingsOrBuilder
      Returns:
      The enum numeric value on the wire for redactionStrategy.

    • setRedactionStrategyValue

      public SecuritySettings.Builder setRedactionStrategyValue(int value)
       Strategy that defines how we do redaction.
      .google.cloud.dialogflow.cx.v3beta1.SecuritySettings.RedactionStrategy redaction_strategy = 3;
      Parameters:
      value - The enum numeric value on the wire for redactionStrategy to set.
      Returns:
      This builder for chaining.

    • getRedactionStrategy

      public SecuritySettings.RedactionStrategy getRedactionStrategy()
       Strategy that defines how we do redaction.
      .google.cloud.dialogflow.cx.v3beta1.SecuritySettings.RedactionStrategy redaction_strategy = 3;
      Specified by:
      getRedactionStrategy in interface SecuritySettingsOrBuilder
      Returns:
      The redactionStrategy.

    • setRedactionStrategy

      public SecuritySettings.Builder setRedactionStrategy(SecuritySettings.RedactionStrategy value)
       Strategy that defines how we do redaction.
      .google.cloud.dialogflow.cx.v3beta1.SecuritySettings.RedactionStrategy redaction_strategy = 3;
      Parameters:
      value - The redactionStrategy to set.
      Returns:
      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:
      This builder for chaining.

    • 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;
      Specified by:
      getRedactionScopeValue in interface SecuritySettingsOrBuilder
      Returns:
      The enum numeric value on the wire for redactionScope.

    • setRedactionScopeValue

      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;
      Parameters:
      value - The enum numeric value on the wire for redactionScope to set.
      Returns:
      This builder for chaining.

    • 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;
      Specified by:
      getRedactionScope in interface SecuritySettingsOrBuilder
      Returns:
      The redactionScope.

    • setRedactionScope

      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;
      Parameters:
      value - The redactionScope to set.
      Returns:
      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:
      This builder for chaining.

    • getInspectTemplate

      public String getInspectTemplate()
       [DLP](https://cloud.google.com/dlp/docs) 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/<ProjectID>/locations/<LocationID>/inspectTemplates/<TemplateID>`
 OR
 `organizations/<OrganizationID>/locations/<LocationID>/inspectTemplates/<TemplateID>`

 Note: `inspect_template` must be located in the same region as the
 `SecuritySettings`.
      string inspect_template = 9 [(.google.api.resource_reference) = { ... }
      Specified by:
      getInspectTemplate in interface SecuritySettingsOrBuilder
      Returns:
      The inspectTemplate.

    • getInspectTemplateBytes

      public com.google.protobuf.ByteString getInspectTemplateBytes()
       [DLP](https://cloud.google.com/dlp/docs) 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/<ProjectID>/locations/<LocationID>/inspectTemplates/<TemplateID>`
 OR
 `organizations/<OrganizationID>/locations/<LocationID>/inspectTemplates/<TemplateID>`

 Note: `inspect_template` must be located in the same region as the
 `SecuritySettings`.
      string inspect_template = 9 [(.google.api.resource_reference) = { ... }
      Specified by:
      getInspectTemplateBytes in interface SecuritySettingsOrBuilder
      Returns:
      The bytes for inspectTemplate.

    • setInspectTemplate

      public SecuritySettings.Builder setInspectTemplate(String value)
       [DLP](https://cloud.google.com/dlp/docs) 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/<ProjectID>/locations/<LocationID>/inspectTemplates/<TemplateID>`
 OR
 `organizations/<OrganizationID>/locations/<LocationID>/inspectTemplates/<TemplateID>`

 Note: `inspect_template` must be located in the same region as the
 `SecuritySettings`.
      string inspect_template = 9 [(.google.api.resource_reference) = { ... }
      Parameters:
      value - The inspectTemplate to set.
      Returns:
      This builder for chaining.

    • clearInspectTemplate

      public SecuritySettings.Builder clearInspectTemplate()
       [DLP](https://cloud.google.com/dlp/docs) 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/<ProjectID>/locations/<LocationID>/inspectTemplates/<TemplateID>`
 OR
 `organizations/<OrganizationID>/locations/<LocationID>/inspectTemplates/<TemplateID>`

 Note: `inspect_template` must be located in the same region as the
 `SecuritySettings`.
      string inspect_template = 9 [(.google.api.resource_reference) = { ... }
      Returns:
      This builder for chaining.

    • setInspectTemplateBytes

      public SecuritySettings.Builder setInspectTemplateBytes(com.google.protobuf.ByteString value)
       [DLP](https://cloud.google.com/dlp/docs) 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/<ProjectID>/locations/<LocationID>/inspectTemplates/<TemplateID>`
 OR
 `organizations/<OrganizationID>/locations/<LocationID>/inspectTemplates/<TemplateID>`

 Note: `inspect_template` must be located in the same region as the
 `SecuritySettings`.
      string inspect_template = 9 [(.google.api.resource_reference) = { ... }
      Parameters:
      value - The bytes for inspectTemplate to set.
      Returns:
      This builder for chaining.

    • getDeidentifyTemplate

      public String getDeidentifyTemplate()
       [DLP](https://cloud.google.com/dlp/docs) 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/<ProjectID>/locations/<LocationID>/deidentifyTemplates/<TemplateID>`
 OR
 `organizations/<OrganizationID>/locations/<LocationID>/deidentifyTemplates/<TemplateID>`

 Note: `deidentify_template` must be located in the same region as the
 `SecuritySettings`.
      string deidentify_template = 17 [(.google.api.resource_reference) = { ... }
      Specified by:
      getDeidentifyTemplate in interface SecuritySettingsOrBuilder
      Returns:
      The deidentifyTemplate.

    • getDeidentifyTemplateBytes

      public com.google.protobuf.ByteString getDeidentifyTemplateBytes()
       [DLP](https://cloud.google.com/dlp/docs) 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/<ProjectID>/locations/<LocationID>/deidentifyTemplates/<TemplateID>`
 OR
 `organizations/<OrganizationID>/locations/<LocationID>/deidentifyTemplates/<TemplateID>`

 Note: `deidentify_template` must be located in the same region as the
 `SecuritySettings`.
      string deidentify_template = 17 [(.google.api.resource_reference) = { ... }
      Specified by:
      getDeidentifyTemplateBytes in interface SecuritySettingsOrBuilder
      Returns:
      The bytes for deidentifyTemplate.

    • setDeidentifyTemplate

      public SecuritySettings.Builder setDeidentifyTemplate(String value)
       [DLP](https://cloud.google.com/dlp/docs) 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/<ProjectID>/locations/<LocationID>/deidentifyTemplates/<TemplateID>`
 OR
 `organizations/<OrganizationID>/locations/<LocationID>/deidentifyTemplates/<TemplateID>`

 Note: `deidentify_template` must be located in the same region as the
 `SecuritySettings`.
      string deidentify_template = 17 [(.google.api.resource_reference) = { ... }
      Parameters:
      value - The deidentifyTemplate to set.
      Returns:
      This builder for chaining.

    • clearDeidentifyTemplate

      public SecuritySettings.Builder clearDeidentifyTemplate()
       [DLP](https://cloud.google.com/dlp/docs) 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/<ProjectID>/locations/<LocationID>/deidentifyTemplates/<TemplateID>`
 OR
 `organizations/<OrganizationID>/locations/<LocationID>/deidentifyTemplates/<TemplateID>`

 Note: `deidentify_template` must be located in the same region as the
 `SecuritySettings`.
      string deidentify_template = 17 [(.google.api.resource_reference) = { ... }
      Returns:
      This builder for chaining.

    • setDeidentifyTemplateBytes

      public SecuritySettings.Builder setDeidentifyTemplateBytes(com.google.protobuf.ByteString value)
       [DLP](https://cloud.google.com/dlp/docs) 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/<ProjectID>/locations/<LocationID>/deidentifyTemplates/<TemplateID>`
 OR
 `organizations/<OrganizationID>/locations/<LocationID>/deidentifyTemplates/<TemplateID>`

 Note: `deidentify_template` must be located in the same region as the
 `SecuritySettings`.
      string deidentify_template = 17 [(.google.api.resource_reference) = { ... }
      Parameters:
      value - The bytes for deidentifyTemplate to set.
      Returns:
      This builder for chaining.

    • 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;
      Specified by:
      hasRetentionWindowDays in interface SecuritySettingsOrBuilder
      Returns:
      Whether the retentionWindowDays field is set.

    • 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;
      Specified by:
      getRetentionWindowDays in interface SecuritySettingsOrBuilder
      Returns:
      The retentionWindowDays.

    • setRetentionWindowDays

      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;
      Parameters:
      value - The retentionWindowDays to set.
      Returns:
      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:
      This builder for chaining.

    • hasRetentionStrategy

      public boolean hasRetentionStrategy()
       Specifies the retention behavior defined by
 [SecuritySettings.RetentionStrategy][google.cloud.dialogflow.cx.v3beta1.SecuritySettings.RetentionStrategy].
      .google.cloud.dialogflow.cx.v3beta1.SecuritySettings.RetentionStrategy retention_strategy = 7;
      Specified by:
      hasRetentionStrategy in interface SecuritySettingsOrBuilder
      Returns:
      Whether the retentionStrategy field is set.

    • getRetentionStrategyValue

      public int getRetentionStrategyValue()
       Specifies the retention behavior defined by
 [SecuritySettings.RetentionStrategy][google.cloud.dialogflow.cx.v3beta1.SecuritySettings.RetentionStrategy].
      .google.cloud.dialogflow.cx.v3beta1.SecuritySettings.RetentionStrategy retention_strategy = 7;
      Specified by:
      getRetentionStrategyValue in interface SecuritySettingsOrBuilder
      Returns:
      The enum numeric value on the wire for retentionStrategy.

    • setRetentionStrategyValue

      public SecuritySettings.Builder setRetentionStrategyValue(int value)
       Specifies the retention behavior defined by
 [SecuritySettings.RetentionStrategy][google.cloud.dialogflow.cx.v3beta1.SecuritySettings.RetentionStrategy].
      .google.cloud.dialogflow.cx.v3beta1.SecuritySettings.RetentionStrategy retention_strategy = 7;
      Parameters:
      value - The enum numeric value on the wire for retentionStrategy to set.
      Returns:
      This builder for chaining.

    • getRetentionStrategy

      public SecuritySettings.RetentionStrategy getRetentionStrategy()
       Specifies the retention behavior defined by
 [SecuritySettings.RetentionStrategy][google.cloud.dialogflow.cx.v3beta1.SecuritySettings.RetentionStrategy].
      .google.cloud.dialogflow.cx.v3beta1.SecuritySettings.RetentionStrategy retention_strategy = 7;
      Specified by:
      getRetentionStrategy in interface SecuritySettingsOrBuilder
      Returns:
      The retentionStrategy.

    • setRetentionStrategy

      public SecuritySettings.Builder setRetentionStrategy(SecuritySettings.RetentionStrategy value)
       Specifies the retention behavior defined by
 [SecuritySettings.RetentionStrategy][google.cloud.dialogflow.cx.v3beta1.SecuritySettings.RetentionStrategy].
      .google.cloud.dialogflow.cx.v3beta1.SecuritySettings.RetentionStrategy retention_strategy = 7;
      Parameters:
      value - The retentionStrategy to set.
      Returns:
      This builder for chaining.

    • clearRetentionStrategy

      public SecuritySettings.Builder clearRetentionStrategy()
       Specifies the retention behavior defined by
 [SecuritySettings.RetentionStrategy][google.cloud.dialogflow.cx.v3beta1.SecuritySettings.RetentionStrategy].
      .google.cloud.dialogflow.cx.v3beta1.SecuritySettings.RetentionStrategy retention_strategy = 7;
      Returns:
      This builder for chaining.

    • 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;
      Specified by:
      getPurgeDataTypesList in interface SecuritySettingsOrBuilder
      Returns:
      A list containing the purgeDataTypes.

    • 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;
      Specified by:
      getPurgeDataTypesCount in interface SecuritySettingsOrBuilder
      Returns:
      The count of purgeDataTypes.

    • getPurgeDataTypes

      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;
      Specified by:
      getPurgeDataTypes in interface SecuritySettingsOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The purgeDataTypes at the given index.

    • setPurgeDataTypes

      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:
      index - The index to set the value at.
      value - The purgeDataTypes to set.
      Returns:
      This builder for chaining.

    • addPurgeDataTypes

      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;
      Parameters:
      value - The purgeDataTypes to add.
      Returns:
      This builder for chaining.

    • addAllPurgeDataTypes

      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;
      Parameters:
      values - The purgeDataTypes to add.
      Returns:
      This builder for chaining.

    • 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:
      This builder for chaining.

    • 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;
      Specified by:
      getPurgeDataTypesValueList in interface SecuritySettingsOrBuilder
      Returns:
      A list containing the enum numeric values on the wire for purgeDataTypes.

    • getPurgeDataTypesValue

      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;
      Specified by:
      getPurgeDataTypesValue in interface SecuritySettingsOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The enum numeric value on the wire of purgeDataTypes at the given index.

    • setPurgeDataTypesValue

      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:
      index - The index to set the value at.
      value - The enum numeric value on the wire for purgeDataTypes to set.
      Returns:
      This builder for chaining.

    • addPurgeDataTypesValue

      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;
      Parameters:
      value - The enum numeric value on the wire for purgeDataTypes to add.
      Returns:
      This builder for chaining.

    • addAllPurgeDataTypesValue

      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;
      Parameters:
      values - The enum numeric values on the wire for purgeDataTypes to add.
      Returns:
      This builder for chaining.

    • 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][google.cloud.dialogflow.cx.v3beta1.SecuritySettings.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][google.cloud.dialogflow.cx.v3beta1.Sessions.DetectIntent]
 or
 [Sessions.StreamingDetectIntent][google.cloud.dialogflow.cx.v3beta1.Sessions.StreamingDetectIntent].
      .google.cloud.dialogflow.cx.v3beta1.SecuritySettings.AudioExportSettings audio_export_settings = 12;
      Specified by:
      hasAudioExportSettings in interface SecuritySettingsOrBuilder
      Returns:
      Whether the audioExportSettings field is set.

    • 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][google.cloud.dialogflow.cx.v3beta1.SecuritySettings.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][google.cloud.dialogflow.cx.v3beta1.Sessions.DetectIntent]
 or
 [Sessions.StreamingDetectIntent][google.cloud.dialogflow.cx.v3beta1.Sessions.StreamingDetectIntent].
      .google.cloud.dialogflow.cx.v3beta1.SecuritySettings.AudioExportSettings audio_export_settings = 12;
      Specified by:
      getAudioExportSettings in interface SecuritySettingsOrBuilder
      Returns:
      The audioExportSettings.

    • setAudioExportSettings

      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][google.cloud.dialogflow.cx.v3beta1.SecuritySettings.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][google.cloud.dialogflow.cx.v3beta1.Sessions.DetectIntent]
 or
 [Sessions.StreamingDetectIntent][google.cloud.dialogflow.cx.v3beta1.Sessions.StreamingDetectIntent].
      .google.cloud.dialogflow.cx.v3beta1.SecuritySettings.AudioExportSettings audio_export_settings = 12;

    • setAudioExportSettings

      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][google.cloud.dialogflow.cx.v3beta1.SecuritySettings.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][google.cloud.dialogflow.cx.v3beta1.Sessions.DetectIntent]
 or
 [Sessions.StreamingDetectIntent][google.cloud.dialogflow.cx.v3beta1.Sessions.StreamingDetectIntent].
      .google.cloud.dialogflow.cx.v3beta1.SecuritySettings.AudioExportSettings audio_export_settings = 12;

    • mergeAudioExportSettings

      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][google.cloud.dialogflow.cx.v3beta1.SecuritySettings.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][google.cloud.dialogflow.cx.v3beta1.Sessions.DetectIntent]
 or
 [Sessions.StreamingDetectIntent][google.cloud.dialogflow.cx.v3beta1.Sessions.StreamingDetectIntent].
      .google.cloud.dialogflow.cx.v3beta1.SecuritySettings.AudioExportSettings audio_export_settings = 12;

    • 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][google.cloud.dialogflow.cx.v3beta1.SecuritySettings.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][google.cloud.dialogflow.cx.v3beta1.Sessions.DetectIntent]
 or
 [Sessions.StreamingDetectIntent][google.cloud.dialogflow.cx.v3beta1.Sessions.StreamingDetectIntent].
      .google.cloud.dialogflow.cx.v3beta1.SecuritySettings.AudioExportSettings audio_export_settings = 12;

    • 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][google.cloud.dialogflow.cx.v3beta1.SecuritySettings.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][google.cloud.dialogflow.cx.v3beta1.Sessions.DetectIntent]
 or
 [Sessions.StreamingDetectIntent][google.cloud.dialogflow.cx.v3beta1.Sessions.StreamingDetectIntent].
      .google.cloud.dialogflow.cx.v3beta1.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][google.cloud.dialogflow.cx.v3beta1.SecuritySettings.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][google.cloud.dialogflow.cx.v3beta1.Sessions.DetectIntent]
 or
 [Sessions.StreamingDetectIntent][google.cloud.dialogflow.cx.v3beta1.Sessions.StreamingDetectIntent].
      .google.cloud.dialogflow.cx.v3beta1.SecuritySettings.AudioExportSettings audio_export_settings = 12;
      Specified by:
      getAudioExportSettingsOrBuilder in interface SecuritySettingsOrBuilder

    • hasInsightsExportSettings

      public boolean hasInsightsExportSettings()
       Controls conversation exporting settings to Insights after conversation is
 completed.

 If
 [retention_strategy][google.cloud.dialogflow.cx.v3beta1.SecuritySettings.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;
      Specified by:
      hasInsightsExportSettings in interface SecuritySettingsOrBuilder
      Returns:
      Whether the insightsExportSettings field is set.

    • getInsightsExportSettings

      public SecuritySettings.InsightsExportSettings getInsightsExportSettings()
       Controls conversation exporting settings to Insights after conversation is
 completed.

 If
 [retention_strategy][google.cloud.dialogflow.cx.v3beta1.SecuritySettings.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;
      Specified by:
      getInsightsExportSettings in interface SecuritySettingsOrBuilder
      Returns:
      The insightsExportSettings.

    • setInsightsExportSettings

      public SecuritySettings.Builder setInsightsExportSettings(SecuritySettings.InsightsExportSettings value)
       Controls conversation exporting settings to Insights after conversation is
 completed.

 If
 [retention_strategy][google.cloud.dialogflow.cx.v3beta1.SecuritySettings.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;

    • setInsightsExportSettings

      public SecuritySettings.Builder setInsightsExportSettings(SecuritySettings.InsightsExportSettings.Builder builderForValue)
       Controls conversation exporting settings to Insights after conversation is
 completed.

 If
 [retention_strategy][google.cloud.dialogflow.cx.v3beta1.SecuritySettings.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;

    • mergeInsightsExportSettings

      public SecuritySettings.Builder mergeInsightsExportSettings(SecuritySettings.InsightsExportSettings value)
       Controls conversation exporting settings to Insights after conversation is
 completed.

 If
 [retention_strategy][google.cloud.dialogflow.cx.v3beta1.SecuritySettings.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;

    • clearInsightsExportSettings

      public SecuritySettings.Builder clearInsightsExportSettings()
       Controls conversation exporting settings to Insights after conversation is
 completed.

 If
 [retention_strategy][google.cloud.dialogflow.cx.v3beta1.SecuritySettings.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;

    • getInsightsExportSettingsBuilder

      public SecuritySettings.InsightsExportSettings.Builder getInsightsExportSettingsBuilder()
       Controls conversation exporting settings to Insights after conversation is
 completed.

 If
 [retention_strategy][google.cloud.dialogflow.cx.v3beta1.SecuritySettings.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;

    • getInsightsExportSettingsOrBuilder

      public SecuritySettings.InsightsExportSettingsOrBuilder getInsightsExportSettingsOrBuilder()
       Controls conversation exporting settings to Insights after conversation is
 completed.

 If
 [retention_strategy][google.cloud.dialogflow.cx.v3beta1.SecuritySettings.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;
      Specified by:
      getInsightsExportSettingsOrBuilder in interface SecuritySettingsOrBuilder