Package com.google.cloud.discoveryengine.v1

Class Control.BoostAction.InterpolationBoostSpec.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<Control.BoostAction.InterpolationBoostSpec.Builder>
com.google.cloud.discoveryengine.v1.Control.BoostAction.InterpolationBoostSpec.Builder
All Implemented Interfaces:
Control.BoostAction.InterpolationBoostSpecOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
Control.BoostAction.InterpolationBoostSpec
public static final class Control.BoostAction.InterpolationBoostSpec.Builder extends com.google.protobuf.GeneratedMessage.Builder<Control.BoostAction.InterpolationBoostSpec.Builder> implements Control.BoostAction.InterpolationBoostSpecOrBuilder
 Specification for custom ranking based on customer specified attribute
 value. It provides more controls for customized ranking than the simple
 (condition, boost) combination above.
Protobuf type google.cloud.discoveryengine.v1.Control.BoostAction.InterpolationBoostSpec

  • 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<Control.BoostAction.InterpolationBoostSpec.Builder>

    • clear

      public Control.BoostAction.InterpolationBoostSpec.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<Control.BoostAction.InterpolationBoostSpec.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<Control.BoostAction.InterpolationBoostSpec.Builder>

    • getDefaultInstanceForType

      public Control.BoostAction.InterpolationBoostSpec getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

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

    • buildPartial

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

    • mergeFrom

      public Control.BoostAction.InterpolationBoostSpec.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<Control.BoostAction.InterpolationBoostSpec.Builder>

    • mergeFrom

      public Control.BoostAction.InterpolationBoostSpec.Builder mergeFrom(Control.BoostAction.InterpolationBoostSpec other)

    • isInitialized

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

    • mergeFrom

      public Control.BoostAction.InterpolationBoostSpec.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<Control.BoostAction.InterpolationBoostSpec.Builder>
      Throws:
      IOException

    • getFieldName

      public String getFieldName()
       Optional. The name of the field whose value will be used to determine
 the boost amount.
      string field_name = 1 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getFieldName in interface Control.BoostAction.InterpolationBoostSpecOrBuilder
      Returns:
      The fieldName.

    • getFieldNameBytes

      public com.google.protobuf.ByteString getFieldNameBytes()
       Optional. The name of the field whose value will be used to determine
 the boost amount.
      string field_name = 1 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getFieldNameBytes in interface Control.BoostAction.InterpolationBoostSpecOrBuilder
      Returns:
      The bytes for fieldName.

    • setFieldName

      public Control.BoostAction.InterpolationBoostSpec.Builder setFieldName(String value)
       Optional. The name of the field whose value will be used to determine
 the boost amount.
      string field_name = 1 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The fieldName to set.
      Returns:
      This builder for chaining.

    • clearFieldName

      public Control.BoostAction.InterpolationBoostSpec.Builder clearFieldName()
       Optional. The name of the field whose value will be used to determine
 the boost amount.
      string field_name = 1 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      This builder for chaining.

    • setFieldNameBytes

      public Control.BoostAction.InterpolationBoostSpec.Builder setFieldNameBytes(com.google.protobuf.ByteString value)
       Optional. The name of the field whose value will be used to determine
 the boost amount.
      string field_name = 1 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The bytes for fieldName to set.
      Returns:
      This builder for chaining.

    • getAttributeTypeValue

      public int getAttributeTypeValue()
       Optional. The attribute type to be used to determine the boost amount.
 The attribute value can be derived from the field value of the
 specified field_name. In the case of numerical it is straightforward
 i.e. attribute_value = numerical_field_value. In the case of freshness
 however, attribute_value = (time.now() - datetime_field_value).
      .google.cloud.discoveryengine.v1.Control.BoostAction.InterpolationBoostSpec.AttributeType attribute_type = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAttributeTypeValue in interface Control.BoostAction.InterpolationBoostSpecOrBuilder
      Returns:
      The enum numeric value on the wire for attributeType.

    • setAttributeTypeValue

      public Control.BoostAction.InterpolationBoostSpec.Builder setAttributeTypeValue(int value)
       Optional. The attribute type to be used to determine the boost amount.
 The attribute value can be derived from the field value of the
 specified field_name. In the case of numerical it is straightforward
 i.e. attribute_value = numerical_field_value. In the case of freshness
 however, attribute_value = (time.now() - datetime_field_value).
      .google.cloud.discoveryengine.v1.Control.BoostAction.InterpolationBoostSpec.AttributeType attribute_type = 2 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The enum numeric value on the wire for attributeType to set.
      Returns:
      This builder for chaining.

    • getAttributeType

      public Control.BoostAction.InterpolationBoostSpec.AttributeType getAttributeType()
       Optional. The attribute type to be used to determine the boost amount.
 The attribute value can be derived from the field value of the
 specified field_name. In the case of numerical it is straightforward
 i.e. attribute_value = numerical_field_value. In the case of freshness
 however, attribute_value = (time.now() - datetime_field_value).
      .google.cloud.discoveryengine.v1.Control.BoostAction.InterpolationBoostSpec.AttributeType attribute_type = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAttributeType in interface Control.BoostAction.InterpolationBoostSpecOrBuilder
      Returns:
      The attributeType.

    • setAttributeType

      public Control.BoostAction.InterpolationBoostSpec.Builder setAttributeType(Control.BoostAction.InterpolationBoostSpec.AttributeType value)
       Optional. The attribute type to be used to determine the boost amount.
 The attribute value can be derived from the field value of the
 specified field_name. In the case of numerical it is straightforward
 i.e. attribute_value = numerical_field_value. In the case of freshness
 however, attribute_value = (time.now() - datetime_field_value).
      .google.cloud.discoveryengine.v1.Control.BoostAction.InterpolationBoostSpec.AttributeType attribute_type = 2 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The attributeType to set.
      Returns:
      This builder for chaining.

    • clearAttributeType

      public Control.BoostAction.InterpolationBoostSpec.Builder clearAttributeType()
       Optional. The attribute type to be used to determine the boost amount.
 The attribute value can be derived from the field value of the
 specified field_name. In the case of numerical it is straightforward
 i.e. attribute_value = numerical_field_value. In the case of freshness
 however, attribute_value = (time.now() - datetime_field_value).
      .google.cloud.discoveryengine.v1.Control.BoostAction.InterpolationBoostSpec.AttributeType attribute_type = 2 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      This builder for chaining.

    • getInterpolationTypeValue

      public int getInterpolationTypeValue()
       Optional. The interpolation type to be applied to connect the control
 points listed below.
      .google.cloud.discoveryengine.v1.Control.BoostAction.InterpolationBoostSpec.InterpolationType interpolation_type = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getInterpolationTypeValue in interface Control.BoostAction.InterpolationBoostSpecOrBuilder
      Returns:
      The enum numeric value on the wire for interpolationType.

    • setInterpolationTypeValue

      public Control.BoostAction.InterpolationBoostSpec.Builder setInterpolationTypeValue(int value)
       Optional. The interpolation type to be applied to connect the control
 points listed below.
      .google.cloud.discoveryengine.v1.Control.BoostAction.InterpolationBoostSpec.InterpolationType interpolation_type = 3 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The enum numeric value on the wire for interpolationType to set.
      Returns:
      This builder for chaining.

    • getInterpolationType

      public Control.BoostAction.InterpolationBoostSpec.InterpolationType getInterpolationType()
       Optional. The interpolation type to be applied to connect the control
 points listed below.
      .google.cloud.discoveryengine.v1.Control.BoostAction.InterpolationBoostSpec.InterpolationType interpolation_type = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getInterpolationType in interface Control.BoostAction.InterpolationBoostSpecOrBuilder
      Returns:
      The interpolationType.

    • setInterpolationType

      public Control.BoostAction.InterpolationBoostSpec.Builder setInterpolationType(Control.BoostAction.InterpolationBoostSpec.InterpolationType value)
       Optional. The interpolation type to be applied to connect the control
 points listed below.
      .google.cloud.discoveryengine.v1.Control.BoostAction.InterpolationBoostSpec.InterpolationType interpolation_type = 3 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The interpolationType to set.
      Returns:
      This builder for chaining.

    • clearInterpolationType

      public Control.BoostAction.InterpolationBoostSpec.Builder clearInterpolationType()
       Optional. The interpolation type to be applied to connect the control
 points listed below.
      .google.cloud.discoveryengine.v1.Control.BoostAction.InterpolationBoostSpec.InterpolationType interpolation_type = 3 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      This builder for chaining.

    • getControlPointsList

      public List<Control.BoostAction.InterpolationBoostSpec.ControlPoint> getControlPointsList()
       Optional. The control points used to define the curve. The monotonic
 function (defined through the interpolation_type above) passes through
 the control points listed here.
      repeated .google.cloud.discoveryengine.v1.Control.BoostAction.InterpolationBoostSpec.ControlPoint control_points = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getControlPointsList in interface Control.BoostAction.InterpolationBoostSpecOrBuilder

    • getControlPointsCount

      public int getControlPointsCount()
       Optional. The control points used to define the curve. The monotonic
 function (defined through the interpolation_type above) passes through
 the control points listed here.
      repeated .google.cloud.discoveryengine.v1.Control.BoostAction.InterpolationBoostSpec.ControlPoint control_points = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getControlPointsCount in interface Control.BoostAction.InterpolationBoostSpecOrBuilder

    • getControlPoints

      public Control.BoostAction.InterpolationBoostSpec.ControlPoint getControlPoints(int index)
       Optional. The control points used to define the curve. The monotonic
 function (defined through the interpolation_type above) passes through
 the control points listed here.
      repeated .google.cloud.discoveryengine.v1.Control.BoostAction.InterpolationBoostSpec.ControlPoint control_points = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getControlPoints in interface Control.BoostAction.InterpolationBoostSpecOrBuilder

    • setControlPoints

      public Control.BoostAction.InterpolationBoostSpec.Builder setControlPoints(int index, Control.BoostAction.InterpolationBoostSpec.ControlPoint value)
       Optional. The control points used to define the curve. The monotonic
 function (defined through the interpolation_type above) passes through
 the control points listed here.
      repeated .google.cloud.discoveryengine.v1.Control.BoostAction.InterpolationBoostSpec.ControlPoint control_points = 4 [(.google.api.field_behavior) = OPTIONAL];

    • setControlPoints

      public Control.BoostAction.InterpolationBoostSpec.Builder setControlPoints(int index, Control.BoostAction.InterpolationBoostSpec.ControlPoint.Builder builderForValue)
       Optional. The control points used to define the curve. The monotonic
 function (defined through the interpolation_type above) passes through
 the control points listed here.
      repeated .google.cloud.discoveryengine.v1.Control.BoostAction.InterpolationBoostSpec.ControlPoint control_points = 4 [(.google.api.field_behavior) = OPTIONAL];

    • addControlPoints

      public Control.BoostAction.InterpolationBoostSpec.Builder addControlPoints(Control.BoostAction.InterpolationBoostSpec.ControlPoint value)
       Optional. The control points used to define the curve. The monotonic
 function (defined through the interpolation_type above) passes through
 the control points listed here.
      repeated .google.cloud.discoveryengine.v1.Control.BoostAction.InterpolationBoostSpec.ControlPoint control_points = 4 [(.google.api.field_behavior) = OPTIONAL];

    • addControlPoints

      public Control.BoostAction.InterpolationBoostSpec.Builder addControlPoints(int index, Control.BoostAction.InterpolationBoostSpec.ControlPoint value)
       Optional. The control points used to define the curve. The monotonic
 function (defined through the interpolation_type above) passes through
 the control points listed here.
      repeated .google.cloud.discoveryengine.v1.Control.BoostAction.InterpolationBoostSpec.ControlPoint control_points = 4 [(.google.api.field_behavior) = OPTIONAL];

    • addControlPoints

      public Control.BoostAction.InterpolationBoostSpec.Builder addControlPoints(Control.BoostAction.InterpolationBoostSpec.ControlPoint.Builder builderForValue)
       Optional. The control points used to define the curve. The monotonic
 function (defined through the interpolation_type above) passes through
 the control points listed here.
      repeated .google.cloud.discoveryengine.v1.Control.BoostAction.InterpolationBoostSpec.ControlPoint control_points = 4 [(.google.api.field_behavior) = OPTIONAL];

    • addControlPoints

      public Control.BoostAction.InterpolationBoostSpec.Builder addControlPoints(int index, Control.BoostAction.InterpolationBoostSpec.ControlPoint.Builder builderForValue)
       Optional. The control points used to define the curve. The monotonic
 function (defined through the interpolation_type above) passes through
 the control points listed here.
      repeated .google.cloud.discoveryengine.v1.Control.BoostAction.InterpolationBoostSpec.ControlPoint control_points = 4 [(.google.api.field_behavior) = OPTIONAL];

    • addAllControlPoints

      public Control.BoostAction.InterpolationBoostSpec.Builder addAllControlPoints(Iterable<? extends Control.BoostAction.InterpolationBoostSpec.ControlPoint> values)
       Optional. The control points used to define the curve. The monotonic
 function (defined through the interpolation_type above) passes through
 the control points listed here.
      repeated .google.cloud.discoveryengine.v1.Control.BoostAction.InterpolationBoostSpec.ControlPoint control_points = 4 [(.google.api.field_behavior) = OPTIONAL];

    • clearControlPoints

      public Control.BoostAction.InterpolationBoostSpec.Builder clearControlPoints()
       Optional. The control points used to define the curve. The monotonic
 function (defined through the interpolation_type above) passes through
 the control points listed here.
      repeated .google.cloud.discoveryengine.v1.Control.BoostAction.InterpolationBoostSpec.ControlPoint control_points = 4 [(.google.api.field_behavior) = OPTIONAL];

    • removeControlPoints

      public Control.BoostAction.InterpolationBoostSpec.Builder removeControlPoints(int index)
       Optional. The control points used to define the curve. The monotonic
 function (defined through the interpolation_type above) passes through
 the control points listed here.
      repeated .google.cloud.discoveryengine.v1.Control.BoostAction.InterpolationBoostSpec.ControlPoint control_points = 4 [(.google.api.field_behavior) = OPTIONAL];

    • getControlPointsBuilder

      public Control.BoostAction.InterpolationBoostSpec.ControlPoint.Builder getControlPointsBuilder(int index)
       Optional. The control points used to define the curve. The monotonic
 function (defined through the interpolation_type above) passes through
 the control points listed here.
      repeated .google.cloud.discoveryengine.v1.Control.BoostAction.InterpolationBoostSpec.ControlPoint control_points = 4 [(.google.api.field_behavior) = OPTIONAL];

    • getControlPointsOrBuilder

      public Control.BoostAction.InterpolationBoostSpec.ControlPointOrBuilder getControlPointsOrBuilder(int index)
       Optional. The control points used to define the curve. The monotonic
 function (defined through the interpolation_type above) passes through
 the control points listed here.
      repeated .google.cloud.discoveryengine.v1.Control.BoostAction.InterpolationBoostSpec.ControlPoint control_points = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getControlPointsOrBuilder in interface Control.BoostAction.InterpolationBoostSpecOrBuilder

    • getControlPointsOrBuilderList

      public List<? extends Control.BoostAction.InterpolationBoostSpec.ControlPointOrBuilder> getControlPointsOrBuilderList()
       Optional. The control points used to define the curve. The monotonic
 function (defined through the interpolation_type above) passes through
 the control points listed here.
      repeated .google.cloud.discoveryengine.v1.Control.BoostAction.InterpolationBoostSpec.ControlPoint control_points = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getControlPointsOrBuilderList in interface Control.BoostAction.InterpolationBoostSpecOrBuilder

    • addControlPointsBuilder

      public Control.BoostAction.InterpolationBoostSpec.ControlPoint.Builder addControlPointsBuilder()
       Optional. The control points used to define the curve. The monotonic
 function (defined through the interpolation_type above) passes through
 the control points listed here.
      repeated .google.cloud.discoveryengine.v1.Control.BoostAction.InterpolationBoostSpec.ControlPoint control_points = 4 [(.google.api.field_behavior) = OPTIONAL];

    • addControlPointsBuilder

      public Control.BoostAction.InterpolationBoostSpec.ControlPoint.Builder addControlPointsBuilder(int index)
       Optional. The control points used to define the curve. The monotonic
 function (defined through the interpolation_type above) passes through
 the control points listed here.
      repeated .google.cloud.discoveryengine.v1.Control.BoostAction.InterpolationBoostSpec.ControlPoint control_points = 4 [(.google.api.field_behavior) = OPTIONAL];

    • getControlPointsBuilderList

      public List<Control.BoostAction.InterpolationBoostSpec.ControlPoint.Builder> getControlPointsBuilderList()
       Optional. The control points used to define the curve. The monotonic
 function (defined through the interpolation_type above) passes through
 the control points listed here.
      repeated .google.cloud.discoveryengine.v1.Control.BoostAction.InterpolationBoostSpec.ControlPoint control_points = 4 [(.google.api.field_behavior) = OPTIONAL];