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

Class BoostSpec.ConditionBoostSpec.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<BoostSpec.ConditionBoostSpec.Builder>
com.google.cloud.dialogflow.cx.v3beta1.BoostSpec.ConditionBoostSpec.Builder
All Implemented Interfaces:
BoostSpec.ConditionBoostSpecOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
BoostSpec.ConditionBoostSpec
public static final class BoostSpec.ConditionBoostSpec.Builder extends com.google.protobuf.GeneratedMessage.Builder<BoostSpec.ConditionBoostSpec.Builder> implements BoostSpec.ConditionBoostSpecOrBuilder
 Boost applies to documents which match a condition.
Protobuf type google.cloud.dialogflow.cx.v3beta1.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<BoostSpec.ConditionBoostSpec.Builder>

    • clear

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

    • getDefaultInstanceForType

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

    • build

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

    • mergeFrom

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

    • mergeFrom

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

    • getCondition

      public String getCondition()
       Optional. An expression which specifies a boost condition. The syntax and
 supported fields are the same as a filter expression.
 Examples:

 * To boost documents with document ID "doc_1" or "doc_2", and
 color
 "Red" or "Blue":
 * (id: ANY("doc_1", "doc_2")) AND (color: ANY("Red","Blue"))
      string condition = 1 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getCondition in interface BoostSpec.ConditionBoostSpecOrBuilder
      Returns:
      The condition.

    • getConditionBytes

      public com.google.protobuf.ByteString getConditionBytes()
       Optional. An expression which specifies a boost condition. The syntax and
 supported fields are the same as a filter expression.
 Examples:

 * To boost documents with document ID "doc_1" or "doc_2", and
 color
 "Red" or "Blue":
 * (id: ANY("doc_1", "doc_2")) AND (color: ANY("Red","Blue"))
      string condition = 1 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getConditionBytes in interface BoostSpec.ConditionBoostSpecOrBuilder
      Returns:
      The bytes for condition.

    • setCondition

      public BoostSpec.ConditionBoostSpec.Builder setCondition(String value)
       Optional. An expression which specifies a boost condition. The syntax and
 supported fields are the same as a filter expression.
 Examples:

 * To boost documents with document ID "doc_1" or "doc_2", and
 color
 "Red" or "Blue":
 * (id: ANY("doc_1", "doc_2")) AND (color: ANY("Red","Blue"))
      string condition = 1 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The condition to set.
      Returns:
      This builder for chaining.

    • clearCondition

      public BoostSpec.ConditionBoostSpec.Builder clearCondition()
       Optional. An expression which specifies a boost condition. The syntax and
 supported fields are the same as a filter expression.
 Examples:

 * To boost documents with document ID "doc_1" or "doc_2", and
 color
 "Red" or "Blue":
 * (id: ANY("doc_1", "doc_2")) AND (color: ANY("Red","Blue"))
      string condition = 1 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      This builder for chaining.

    • setConditionBytes

      public BoostSpec.ConditionBoostSpec.Builder setConditionBytes(com.google.protobuf.ByteString value)
       Optional. An expression which specifies a boost condition. The syntax and
 supported fields are the same as a filter expression.
 Examples:

 * To boost documents with document ID "doc_1" or "doc_2", and
 color
 "Red" or "Blue":
 * (id: ANY("doc_1", "doc_2")) AND (color: ANY("Red","Blue"))
      string condition = 1 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The bytes for condition to set.
      Returns:
      This builder for chaining.

    • getBoost

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

 Setting to 1.0 gives the document a big promotion. However, it does not
 necessarily mean that the boosted document will be the top result at
 all times, nor that other documents will be excluded. Results could
 still be shown even when none of them matches the condition. And
 results that are significantly more relevant to the search query can
 still trump your heavily favored but irrelevant documents.

 Setting to -1.0 gives the document a big demotion. However, results
 that are deeply relevant might still be shown. The document will have
 an upstream battle to get a fairly high ranking, but it is not blocked
 out completely.

 Setting to 0.0 means no boost applied. The boosting condition is
 ignored.
      float boost = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getBoost in interface BoostSpec.ConditionBoostSpecOrBuilder
      Returns:
      The boost.

    • setBoost

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

 Setting to 1.0 gives the document a big promotion. However, it does not
 necessarily mean that the boosted document will be the top result at
 all times, nor that other documents will be excluded. Results could
 still be shown even when none of them matches the condition. And
 results that are significantly more relevant to the search query can
 still trump your heavily favored but irrelevant documents.

 Setting to -1.0 gives the document a big demotion. However, results
 that are deeply relevant might still be shown. The document will have
 an upstream battle to get a fairly high ranking, but it is not blocked
 out completely.

 Setting to 0.0 means no boost applied. The boosting condition is
 ignored.
      float boost = 2 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The boost to set.
      Returns:
      This builder for chaining.

    • clearBoost

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

 Setting to 1.0 gives the document a big promotion. However, it does not
 necessarily mean that the boosted document will be the top result at
 all times, nor that other documents will be excluded. Results could
 still be shown even when none of them matches the condition. And
 results that are significantly more relevant to the search query can
 still trump your heavily favored but irrelevant documents.

 Setting to -1.0 gives the document a big demotion. However, results
 that are deeply relevant might still be shown. The document will have
 an upstream battle to get a fairly high ranking, but it is not blocked
 out completely.

 Setting to 0.0 means no boost applied. The boosting condition is
 ignored.
      float boost = 2 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      This builder for chaining.

    • hasBoostControlSpec

      public boolean hasBoostControlSpec()
       Optional. Complex specification for custom ranking based on customer
 defined attribute value.
      .google.cloud.dialogflow.cx.v3beta1.BoostSpec.ConditionBoostSpec.BoostControlSpec boost_control_spec = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasBoostControlSpec in interface BoostSpec.ConditionBoostSpecOrBuilder
      Returns:
      Whether the boostControlSpec field is set.

    • getBoostControlSpec

      public BoostSpec.ConditionBoostSpec.BoostControlSpec getBoostControlSpec()
       Optional. Complex specification for custom ranking based on customer
 defined attribute value.
      .google.cloud.dialogflow.cx.v3beta1.BoostSpec.ConditionBoostSpec.BoostControlSpec boost_control_spec = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getBoostControlSpec in interface BoostSpec.ConditionBoostSpecOrBuilder
      Returns:
      The boostControlSpec.

    • setBoostControlSpec

      public BoostSpec.ConditionBoostSpec.Builder setBoostControlSpec(BoostSpec.ConditionBoostSpec.BoostControlSpec value)
       Optional. Complex specification for custom ranking based on customer
 defined attribute value.
      .google.cloud.dialogflow.cx.v3beta1.BoostSpec.ConditionBoostSpec.BoostControlSpec boost_control_spec = 4 [(.google.api.field_behavior) = OPTIONAL];

    • setBoostControlSpec

      public BoostSpec.ConditionBoostSpec.Builder setBoostControlSpec(BoostSpec.ConditionBoostSpec.BoostControlSpec.Builder builderForValue)
       Optional. Complex specification for custom ranking based on customer
 defined attribute value.
      .google.cloud.dialogflow.cx.v3beta1.BoostSpec.ConditionBoostSpec.BoostControlSpec boost_control_spec = 4 [(.google.api.field_behavior) = OPTIONAL];

    • mergeBoostControlSpec

      public BoostSpec.ConditionBoostSpec.Builder mergeBoostControlSpec(BoostSpec.ConditionBoostSpec.BoostControlSpec value)
       Optional. Complex specification for custom ranking based on customer
 defined attribute value.
      .google.cloud.dialogflow.cx.v3beta1.BoostSpec.ConditionBoostSpec.BoostControlSpec boost_control_spec = 4 [(.google.api.field_behavior) = OPTIONAL];

    • clearBoostControlSpec

      public BoostSpec.ConditionBoostSpec.Builder clearBoostControlSpec()
       Optional. Complex specification for custom ranking based on customer
 defined attribute value.
      .google.cloud.dialogflow.cx.v3beta1.BoostSpec.ConditionBoostSpec.BoostControlSpec boost_control_spec = 4 [(.google.api.field_behavior) = OPTIONAL];

    • getBoostControlSpecBuilder

      public BoostSpec.ConditionBoostSpec.BoostControlSpec.Builder getBoostControlSpecBuilder()
       Optional. Complex specification for custom ranking based on customer
 defined attribute value.
      .google.cloud.dialogflow.cx.v3beta1.BoostSpec.ConditionBoostSpec.BoostControlSpec boost_control_spec = 4 [(.google.api.field_behavior) = OPTIONAL];

    • getBoostControlSpecOrBuilder

      public BoostSpec.ConditionBoostSpec.BoostControlSpecOrBuilder getBoostControlSpecOrBuilder()
       Optional. Complex specification for custom ranking based on customer
 defined attribute value.
      .google.cloud.dialogflow.cx.v3beta1.BoostSpec.ConditionBoostSpec.BoostControlSpec boost_control_spec = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getBoostControlSpecOrBuilder in interface BoostSpec.ConditionBoostSpecOrBuilder