Interface SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpecOrBuilder (0.44.0)

Version 0.44.0

• 0.49.0 (latest)
• 0.48.0
• 0.47.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.38.0
• 0.37.0
• 0.36.0
• 0.35.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.0

public static interface SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpecOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAttributeType()

public abstract 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;

Returns
Type	Description
SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.AttributeType	The attributeType.

getAttributeTypeValue()

public abstract 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 abstract 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
index	int

Returns
Type	Description
SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.ControlPoint

getControlPointsCount()

public abstract 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 abstract 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;

Returns
Type	Description
List<ControlPoint>

getControlPointsOrBuilder(int index)

public abstract 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
index	int

Returns
Type	Description
SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.ControlPointOrBuilder

getControlPointsOrBuilderList()

public abstract 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>

getFieldName()

public abstract 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 abstract 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 abstract 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;

Returns
Type	Description
SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.InterpolationType	The interpolationType.

getInterpolationTypeValue()

public abstract 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.