Class Control.BoostAction.InterpolationBoostSpec (0.72.0)
Version 0.72.0keyboard_arrow_down
public static final class Control . BoostAction . InterpolationBoostSpec extends GeneratedMessageV3 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
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
ATTRIBUTE_TYPE_FIELD_NUMBER
public static final int ATTRIBUTE_TYPE_FIELD_NUMBER
Field Value
Type Description
int
CONTROL_POINTS_FIELD_NUMBER
public static final int CONTROL_POINTS_FIELD_NUMBER
Field Value
Type Description
int
FIELD_NAME_FIELD_NUMBER
public static final int FIELD_NAME_FIELD_NUMBER
Field Value
Type Description
int
INTERPOLATION_TYPE_FIELD_NUMBER
public static final int INTERPOLATION_TYPE_FIELD_NUMBER
Field Value
Type Description
int
Static Methods
getDefaultInstance()
public static Control . BoostAction . InterpolationBoostSpec getDefaultInstance ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static Control . BoostAction . InterpolationBoostSpec . Builder newBuilder ()
newBuilder(Control.BoostAction.InterpolationBoostSpec prototype)
public static Control . BoostAction . InterpolationBoostSpec . Builder newBuilder ( Control . BoostAction . InterpolationBoostSpec prototype )
public static Control . BoostAction . InterpolationBoostSpec parseDelimitedFrom ( InputStream input )
public static Control . BoostAction . InterpolationBoostSpec parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static Control . BoostAction . InterpolationBoostSpec parseFrom ( byte [] data )
Parameter
Name Description
databyte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Control . BoostAction . InterpolationBoostSpec parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static Control . BoostAction . InterpolationBoostSpec parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Control . BoostAction . InterpolationBoostSpec parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static Control . BoostAction . InterpolationBoostSpec parseFrom ( CodedInputStream input )
public static Control . BoostAction . InterpolationBoostSpec parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static Control . BoostAction . InterpolationBoostSpec parseFrom ( InputStream input )
public static Control . BoostAction . InterpolationBoostSpec parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static Control . BoostAction . InterpolationBoostSpec parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Control . BoostAction . InterpolationBoostSpec parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<Control . BoostAction . InterpolationBoostSpec > parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Name Description
objObject
Overrides
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];
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];
Returns
Type Description
int The enum numeric value on the wire for attributeType.
getControlPoints(int index)
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];
Parameter
Name Description
indexint
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];
Returns
Type Description
int
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];
getControlPointsOrBuilder(int index)
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];
Parameter
Name Description
indexint
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];
Returns
Type Description
List <? extends com.google.cloud.discoveryengine.v1.Control.BoostAction.InterpolationBoostSpec.ControlPointOrBuilder >
getDefaultInstanceForType()
public Control . BoostAction . InterpolationBoostSpec getDefaultInstanceForType ()
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];
Returns
Type Description
String The fieldName.
getFieldNameBytes()
public 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];
Returns
Type Description
ByteString The bytes for fieldName.
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];
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];
Returns
Type Description
int The enum numeric value on the wire for interpolationType.
getParserForType()
public Parser<Control . BoostAction . InterpolationBoostSpec > getParserForType ()
Overrides
getSerializedSize()
public int getSerializedSize ()
Returns
Type Description
int
Overrides
hashCode()
Returns
Type Description
int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public Control . BoostAction . InterpolationBoostSpec . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Control . BoostAction . InterpolationBoostSpec . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
toBuilder()
public Control . BoostAction . InterpolationBoostSpec . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-10-29 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-10-29 UTC."],[],[]]
