Send feedback
Class SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec (0.42.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version 0.42.0 keyboard_arrow_down
public static final class SearchRequest . BoostSpec . ConditionBoostSpec . BoostControlSpec extends GeneratedMessageV3 implements SearchRequest . BoostSpec . ConditionBoostSpec . BoostControlSpecOrBuilder
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.v1alpha.SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec
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 SearchRequest . BoostSpec . ConditionBoostSpec . BoostControlSpec getDefaultInstance ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static SearchRequest . BoostSpec . ConditionBoostSpec . BoostControlSpec . Builder newBuilder ()
newBuilder(SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec prototype)
public static SearchRequest . BoostSpec . ConditionBoostSpec . BoostControlSpec . Builder newBuilder ( SearchRequest . BoostSpec . ConditionBoostSpec . BoostControlSpec prototype )
public static SearchRequest . BoostSpec . ConditionBoostSpec . BoostControlSpec parseDelimitedFrom ( InputStream input )
public static SearchRequest . BoostSpec . ConditionBoostSpec . BoostControlSpec parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static SearchRequest . BoostSpec . ConditionBoostSpec . BoostControlSpec parseFrom ( byte [] data )
Parameter
Name Description
databyte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static SearchRequest . BoostSpec . ConditionBoostSpec . BoostControlSpec parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static SearchRequest . BoostSpec . ConditionBoostSpec . BoostControlSpec parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static SearchRequest . BoostSpec . ConditionBoostSpec . BoostControlSpec parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static SearchRequest . BoostSpec . ConditionBoostSpec . BoostControlSpec parseFrom ( CodedInputStream input )
public static SearchRequest . BoostSpec . ConditionBoostSpec . BoostControlSpec parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static SearchRequest . BoostSpec . ConditionBoostSpec . BoostControlSpec parseFrom ( InputStream input )
public static SearchRequest . BoostSpec . ConditionBoostSpec . BoostControlSpec parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static SearchRequest . BoostSpec . ConditionBoostSpec . BoostControlSpec parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static SearchRequest . BoostSpec . ConditionBoostSpec . BoostControlSpec parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<SearchRequest . BoostSpec . ConditionBoostSpec . BoostControlSpec > parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Name Description
objObject
Overrides
getAttributeType()
public SearchRequest . BoostSpec . ConditionBoostSpec . BoostControlSpec . AttributeType getAttributeType ()
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.v1alpha.SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.AttributeType attribute_type = 2;
getAttributeTypeValue()
public int getAttributeTypeValue ()
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.v1alpha.SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.AttributeType attribute_type = 2;
Returns
Type Description
int The enum numeric value on the wire for attributeType.
getControlPoints(int index)
public SearchRequest . BoostSpec . ConditionBoostSpec . BoostControlSpec . ControlPoint getControlPoints ( int index )
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.v1alpha.SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.ControlPoint control_points = 4;
Parameter
Name Description
indexint
getControlPointsCount()
public int getControlPointsCount ()
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.v1alpha.SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.ControlPoint control_points = 4;
Returns
Type Description
int
getControlPointsList()
public List<SearchRequest . BoostSpec . ConditionBoostSpec . BoostControlSpec . ControlPoint > getControlPointsList ()
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.v1alpha.SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.ControlPoint control_points = 4;
getControlPointsOrBuilder(int index)
public SearchRequest . BoostSpec . ConditionBoostSpec . BoostControlSpec . ControlPointOrBuilder getControlPointsOrBuilder ( int index )
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.v1alpha.SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.ControlPoint control_points = 4;
Parameter
Name Description
indexint
getControlPointsOrBuilderList()
public List <? extends SearchRequest . BoostSpec . ConditionBoostSpec . BoostControlSpec . ControlPointOrBuilder > getControlPointsOrBuilderList ()
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.v1alpha.SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.ControlPoint control_points = 4;
Returns
Type Description
List <? extends com.google.cloud.discoveryengine.v1alpha.SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.ControlPointOrBuilder >
getDefaultInstanceForType()
public SearchRequest . BoostSpec . ConditionBoostSpec . BoostControlSpec getDefaultInstanceForType ()
getFieldName()
public String getFieldName ()
The name of the field whose value will be used to determine the
boost amount.
string field_name = 1;
Returns
Type Description
String The fieldName.
getFieldNameBytes()
public ByteString getFieldNameBytes ()
The name of the field whose value will be used to determine the
boost amount.
string field_name = 1;
Returns
Type Description
ByteString The bytes for fieldName.
getInterpolationType()
public SearchRequest . BoostSpec . ConditionBoostSpec . BoostControlSpec . InterpolationType getInterpolationType ()
The interpolation type to be applied to connect the control points
listed below.
.google.cloud.discoveryengine.v1alpha.SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.InterpolationType interpolation_type = 3;
getInterpolationTypeValue()
public int getInterpolationTypeValue ()
The interpolation type to be applied to connect the control points
listed below.
.google.cloud.discoveryengine.v1alpha.SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.InterpolationType interpolation_type = 3;
Returns
Type Description
int The enum numeric value on the wire for interpolationType.
getParserForType()
public Parser<SearchRequest . BoostSpec . ConditionBoostSpec . BoostControlSpec > 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 SearchRequest . BoostSpec . ConditionBoostSpec . BoostControlSpec . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected SearchRequest . BoostSpec . ConditionBoostSpec . BoostControlSpec . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
toBuilder()
public SearchRequest . BoostSpec . ConditionBoostSpec . BoostControlSpec . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
Send feedback
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-01-27 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-01-27 UTC."],[],[]]
