Package com.google.cloud.discoveryengine.v1

Class AnswerQueryRequest.SafetySpec.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<AnswerQueryRequest.SafetySpec.Builder>
com.google.cloud.discoveryengine.v1.AnswerQueryRequest.SafetySpec.Builder
All Implemented Interfaces:
AnswerQueryRequest.SafetySpecOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
AnswerQueryRequest.SafetySpec
public static final class AnswerQueryRequest.SafetySpec.Builder extends com.google.protobuf.GeneratedMessage.Builder<AnswerQueryRequest.SafetySpec.Builder> implements AnswerQueryRequest.SafetySpecOrBuilder
 Safety specification.
 There are two use cases:
 1. when only safety_spec.enable is set, the BLOCK_LOW_AND_ABOVE threshold
 will be applied for all categories.
 2. when safety_spec.enable is set and some safety_settings are set, only
 specified safety_settings are applied.
Protobuf type google.cloud.discoveryengine.v1.AnswerQueryRequest.SafetySpec

  • 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<AnswerQueryRequest.SafetySpec.Builder>

    • clear

      public AnswerQueryRequest.SafetySpec.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<AnswerQueryRequest.SafetySpec.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<AnswerQueryRequest.SafetySpec.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • mergeFrom

      public AnswerQueryRequest.SafetySpec.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<AnswerQueryRequest.SafetySpec.Builder>

    • mergeFrom

      public AnswerQueryRequest.SafetySpec.Builder mergeFrom(AnswerQueryRequest.SafetySpec other)

    • isInitialized

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

    • mergeFrom

      public AnswerQueryRequest.SafetySpec.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<AnswerQueryRequest.SafetySpec.Builder>
      Throws:
      IOException

    • getEnable

      public boolean getEnable()
       Enable the safety filtering on the answer response. It is false by
 default.
      bool enable = 1;
      Specified by:
      getEnable in interface AnswerQueryRequest.SafetySpecOrBuilder
      Returns:
      The enable.

    • setEnable

      public AnswerQueryRequest.SafetySpec.Builder setEnable(boolean value)
       Enable the safety filtering on the answer response. It is false by
 default.
      bool enable = 1;
      Parameters:
      value - The enable to set.
      Returns:
      This builder for chaining.

    • clearEnable

      public AnswerQueryRequest.SafetySpec.Builder clearEnable()
       Enable the safety filtering on the answer response. It is false by
 default.
      bool enable = 1;
      Returns:
      This builder for chaining.

    • getSafetySettingsList

      public List<AnswerQueryRequest.SafetySpec.SafetySetting> getSafetySettingsList()
       Optional. Safety settings.
 This settings are effective only when the safety_spec.enable is true.
      repeated .google.cloud.discoveryengine.v1.AnswerQueryRequest.SafetySpec.SafetySetting safety_settings = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getSafetySettingsList in interface AnswerQueryRequest.SafetySpecOrBuilder

    • getSafetySettingsCount

      public int getSafetySettingsCount()
       Optional. Safety settings.
 This settings are effective only when the safety_spec.enable is true.
      repeated .google.cloud.discoveryengine.v1.AnswerQueryRequest.SafetySpec.SafetySetting safety_settings = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getSafetySettingsCount in interface AnswerQueryRequest.SafetySpecOrBuilder

    • getSafetySettings

      public AnswerQueryRequest.SafetySpec.SafetySetting getSafetySettings(int index)
       Optional. Safety settings.
 This settings are effective only when the safety_spec.enable is true.
      repeated .google.cloud.discoveryengine.v1.AnswerQueryRequest.SafetySpec.SafetySetting safety_settings = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getSafetySettings in interface AnswerQueryRequest.SafetySpecOrBuilder

    • setSafetySettings

      public AnswerQueryRequest.SafetySpec.Builder setSafetySettings(int index, AnswerQueryRequest.SafetySpec.SafetySetting value)
       Optional. Safety settings.
 This settings are effective only when the safety_spec.enable is true.
      repeated .google.cloud.discoveryengine.v1.AnswerQueryRequest.SafetySpec.SafetySetting safety_settings = 2 [(.google.api.field_behavior) = OPTIONAL];

    • setSafetySettings

      public AnswerQueryRequest.SafetySpec.Builder setSafetySettings(int index, AnswerQueryRequest.SafetySpec.SafetySetting.Builder builderForValue)
       Optional. Safety settings.
 This settings are effective only when the safety_spec.enable is true.
      repeated .google.cloud.discoveryengine.v1.AnswerQueryRequest.SafetySpec.SafetySetting safety_settings = 2 [(.google.api.field_behavior) = OPTIONAL];

    • addSafetySettings

      public AnswerQueryRequest.SafetySpec.Builder addSafetySettings(AnswerQueryRequest.SafetySpec.SafetySetting value)
       Optional. Safety settings.
 This settings are effective only when the safety_spec.enable is true.
      repeated .google.cloud.discoveryengine.v1.AnswerQueryRequest.SafetySpec.SafetySetting safety_settings = 2 [(.google.api.field_behavior) = OPTIONAL];

    • addSafetySettings

      public AnswerQueryRequest.SafetySpec.Builder addSafetySettings(int index, AnswerQueryRequest.SafetySpec.SafetySetting value)
       Optional. Safety settings.
 This settings are effective only when the safety_spec.enable is true.
      repeated .google.cloud.discoveryengine.v1.AnswerQueryRequest.SafetySpec.SafetySetting safety_settings = 2 [(.google.api.field_behavior) = OPTIONAL];

    • addSafetySettings

      public AnswerQueryRequest.SafetySpec.Builder addSafetySettings(AnswerQueryRequest.SafetySpec.SafetySetting.Builder builderForValue)
       Optional. Safety settings.
 This settings are effective only when the safety_spec.enable is true.
      repeated .google.cloud.discoveryengine.v1.AnswerQueryRequest.SafetySpec.SafetySetting safety_settings = 2 [(.google.api.field_behavior) = OPTIONAL];

    • addSafetySettings

      public AnswerQueryRequest.SafetySpec.Builder addSafetySettings(int index, AnswerQueryRequest.SafetySpec.SafetySetting.Builder builderForValue)
       Optional. Safety settings.
 This settings are effective only when the safety_spec.enable is true.
      repeated .google.cloud.discoveryengine.v1.AnswerQueryRequest.SafetySpec.SafetySetting safety_settings = 2 [(.google.api.field_behavior) = OPTIONAL];

    • addAllSafetySettings

      public AnswerQueryRequest.SafetySpec.Builder addAllSafetySettings(Iterable<? extends AnswerQueryRequest.SafetySpec.SafetySetting> values)
       Optional. Safety settings.
 This settings are effective only when the safety_spec.enable is true.
      repeated .google.cloud.discoveryengine.v1.AnswerQueryRequest.SafetySpec.SafetySetting safety_settings = 2 [(.google.api.field_behavior) = OPTIONAL];

    • clearSafetySettings

      public AnswerQueryRequest.SafetySpec.Builder clearSafetySettings()
       Optional. Safety settings.
 This settings are effective only when the safety_spec.enable is true.
      repeated .google.cloud.discoveryengine.v1.AnswerQueryRequest.SafetySpec.SafetySetting safety_settings = 2 [(.google.api.field_behavior) = OPTIONAL];

    • removeSafetySettings

      public AnswerQueryRequest.SafetySpec.Builder removeSafetySettings(int index)
       Optional. Safety settings.
 This settings are effective only when the safety_spec.enable is true.
      repeated .google.cloud.discoveryengine.v1.AnswerQueryRequest.SafetySpec.SafetySetting safety_settings = 2 [(.google.api.field_behavior) = OPTIONAL];

    • getSafetySettingsBuilder

      public AnswerQueryRequest.SafetySpec.SafetySetting.Builder getSafetySettingsBuilder(int index)
       Optional. Safety settings.
 This settings are effective only when the safety_spec.enable is true.
      repeated .google.cloud.discoveryengine.v1.AnswerQueryRequest.SafetySpec.SafetySetting safety_settings = 2 [(.google.api.field_behavior) = OPTIONAL];

    • getSafetySettingsOrBuilder

      public AnswerQueryRequest.SafetySpec.SafetySettingOrBuilder getSafetySettingsOrBuilder(int index)
       Optional. Safety settings.
 This settings are effective only when the safety_spec.enable is true.
      repeated .google.cloud.discoveryengine.v1.AnswerQueryRequest.SafetySpec.SafetySetting safety_settings = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getSafetySettingsOrBuilder in interface AnswerQueryRequest.SafetySpecOrBuilder

    • getSafetySettingsOrBuilderList

      public List<? extends AnswerQueryRequest.SafetySpec.SafetySettingOrBuilder> getSafetySettingsOrBuilderList()
       Optional. Safety settings.
 This settings are effective only when the safety_spec.enable is true.
      repeated .google.cloud.discoveryengine.v1.AnswerQueryRequest.SafetySpec.SafetySetting safety_settings = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getSafetySettingsOrBuilderList in interface AnswerQueryRequest.SafetySpecOrBuilder

    • addSafetySettingsBuilder

      public AnswerQueryRequest.SafetySpec.SafetySetting.Builder addSafetySettingsBuilder()
       Optional. Safety settings.
 This settings are effective only when the safety_spec.enable is true.
      repeated .google.cloud.discoveryengine.v1.AnswerQueryRequest.SafetySpec.SafetySetting safety_settings = 2 [(.google.api.field_behavior) = OPTIONAL];

    • addSafetySettingsBuilder

      public AnswerQueryRequest.SafetySpec.SafetySetting.Builder addSafetySettingsBuilder(int index)
       Optional. Safety settings.
 This settings are effective only when the safety_spec.enable is true.
      repeated .google.cloud.discoveryengine.v1.AnswerQueryRequest.SafetySpec.SafetySetting safety_settings = 2 [(.google.api.field_behavior) = OPTIONAL];

    • getSafetySettingsBuilderList

      public List<AnswerQueryRequest.SafetySpec.SafetySetting.Builder> getSafetySettingsBuilderList()
       Optional. Safety settings.
 This settings are effective only when the safety_spec.enable is true.
      repeated .google.cloud.discoveryengine.v1.AnswerQueryRequest.SafetySpec.SafetySetting safety_settings = 2 [(.google.api.field_behavior) = OPTIONAL];