Package com.google.cloud.discoveryengine.v1beta

Class AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec.Builder>
com.google.cloud.discoveryengine.v1beta.AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec.Builder
All Implemented Interfaces:
AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpecOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec
public static final class AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec.Builder extends com.google.protobuf.GeneratedMessage.Builder<AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec.Builder> implements AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpecOrBuilder
 Boost applies to suggestions which match a condition.
Protobuf type google.cloud.discoveryengine.v1beta.AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec

  • 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<AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec.Builder>

    • clear

      public AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec.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<AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec.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<AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec.Builder>

    • getDefaultInstanceForType

      public AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

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

    • buildPartial

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

    • mergeFrom

      public AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec.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<AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec.Builder>

    • mergeFrom

      public AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec.Builder mergeFrom(AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec other)

    • isInitialized

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

    • mergeFrom

      public AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec.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<AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec.Builder>
      Throws:
      IOException

    • getCondition

      public String getCondition()
       An expression which specifies a boost condition. The syntax is the same
 as [filter expression
 syntax](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata#filter-expression-syntax).
 Currently, the only supported condition is a list of BCP-47 lang codes.

 Example:

 * To boost suggestions in languages `en` or `fr`:
 `(lang_code: ANY("en", "fr"))`
      string condition = 1;
      Specified by:
      getCondition in interface AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpecOrBuilder
      Returns:
      The condition.

    • getConditionBytes

      public com.google.protobuf.ByteString getConditionBytes()
       An expression which specifies a boost condition. The syntax is the same
 as [filter expression
 syntax](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata#filter-expression-syntax).
 Currently, the only supported condition is a list of BCP-47 lang codes.

 Example:

 * To boost suggestions in languages `en` or `fr`:
 `(lang_code: ANY("en", "fr"))`
      string condition = 1;
      Specified by:
      getConditionBytes in interface AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpecOrBuilder
      Returns:
      The bytes for condition.

    • setCondition

      public AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec.Builder setCondition(String value)
       An expression which specifies a boost condition. The syntax is the same
 as [filter expression
 syntax](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata#filter-expression-syntax).
 Currently, the only supported condition is a list of BCP-47 lang codes.

 Example:

 * To boost suggestions in languages `en` or `fr`:
 `(lang_code: ANY("en", "fr"))`
      string condition = 1;
      Parameters:
      value - The condition to set.
      Returns:
      This builder for chaining.

    • clearCondition

      public AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec.Builder clearCondition()
       An expression which specifies a boost condition. The syntax is the same
 as [filter expression
 syntax](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata#filter-expression-syntax).
 Currently, the only supported condition is a list of BCP-47 lang codes.

 Example:

 * To boost suggestions in languages `en` or `fr`:
 `(lang_code: ANY("en", "fr"))`
      string condition = 1;
      Returns:
      This builder for chaining.

    • setConditionBytes

      public AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec.Builder setConditionBytes(com.google.protobuf.ByteString value)
       An expression which specifies a boost condition. The syntax is the same
 as [filter expression
 syntax](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata#filter-expression-syntax).
 Currently, the only supported condition is a list of BCP-47 lang codes.

 Example:

 * To boost suggestions in languages `en` or `fr`:
 `(lang_code: ANY("en", "fr"))`
      string condition = 1;
      Parameters:
      value - The bytes for condition to set.
      Returns:
      This builder for chaining.

    • getBoost

      public float getBoost()
       Strength of the boost, which should be in [-1, 1].
 Negative boost means demotion. Default is 0.0.

 Setting to 1.0 gives the suggestions a big promotion. However, it does
 not necessarily mean that the top result will be a boosted suggestion.

 Setting to -1.0 gives the suggestions a big demotion. However, other
 suggestions that are relevant might still be shown.

 Setting to 0.0 means no boost applied. The boosting condition is
 ignored.
      float boost = 2;
      Specified by:
      getBoost in interface AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpecOrBuilder
      Returns:
      The boost.

    • setBoost

      public AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec.Builder setBoost(float value)
       Strength of the boost, which should be in [-1, 1].
 Negative boost means demotion. Default is 0.0.

 Setting to 1.0 gives the suggestions a big promotion. However, it does
 not necessarily mean that the top result will be a boosted suggestion.

 Setting to -1.0 gives the suggestions a big demotion. However, other
 suggestions that are relevant might still be shown.

 Setting to 0.0 means no boost applied. The boosting condition is
 ignored.
      float boost = 2;
      Parameters:
      value - The boost to set.
      Returns:
      This builder for chaining.

    • clearBoost

      public AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec.Builder clearBoost()
       Strength of the boost, which should be in [-1, 1].
 Negative boost means demotion. Default is 0.0.

 Setting to 1.0 gives the suggestions a big promotion. However, it does
 not necessarily mean that the top result will be a boosted suggestion.

 Setting to -1.0 gives the suggestions a big demotion. However, other
 suggestions that are relevant might still be shown.

 Setting to 0.0 means no boost applied. The boosting condition is
 ignored.
      float boost = 2;
      Returns:
      This builder for chaining.