com.google.cloud.discoveryengine.v1beta

Interface SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpecOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec, SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.Builder

Enclosing class:

SearchRequest.BoostSpec.ConditionBoostSpec

public static interface SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpecOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.AttributeType	getAttributeType() The attribute type to be used to determine the boost amount.
int	getAttributeTypeValue() The attribute type to be used to determine the boost amount.
SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.ControlPoint	getControlPoints(int index) The control points used to define the curve.
int	getControlPointsCount() The control points used to define the curve.
List<SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.ControlPoint>	getControlPointsList() The control points used to define the curve.
SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.ControlPointOrBuilder	getControlPointsOrBuilder(int index) The control points used to define the curve.
List<? extends SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.ControlPointOrBuilder>	getControlPointsOrBuilderList() The control points used to define the curve.
String	getFieldName() The name of the field whose value will be used to determine the boost amount.
com.google.protobuf.ByteString	getFieldNameBytes() The name of the field whose value will be used to determine the boost amount.
SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.InterpolationType	getInterpolationType() The interpolation type to be applied to connect the control points listed below.
int	getInterpolationTypeValue() The interpolation type to be applied to connect the control points listed below.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getFieldName

String getFieldName()

 The name of the field whose value will be used to determine the
 boost amount.
 

string field_name = 1;

Returns:

The fieldName.

getFieldNameBytes

com.google.protobuf.ByteString getFieldNameBytes()

 The name of the field whose value will be used to determine the
 boost amount.
 

string field_name = 1;

Returns:

The bytes for fieldName.

getAttributeTypeValue

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.v1beta.SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.AttributeType attribute_type = 2;

Returns:

The enum numeric value on the wire for attributeType.

getAttributeType

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.v1beta.SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.AttributeType attribute_type = 2;

Returns:

The attributeType.

getInterpolationTypeValue

int getInterpolationTypeValue()

 The interpolation type to be applied to connect the control points
 listed below.
 

.google.cloud.discoveryengine.v1beta.SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.InterpolationType interpolation_type = 3;

Returns:

The enum numeric value on the wire for interpolationType.

getInterpolationType

SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.InterpolationType getInterpolationType()

 The interpolation type to be applied to connect the control points
 listed below.
 

.google.cloud.discoveryengine.v1beta.SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.InterpolationType interpolation_type = 3;

Returns:

The interpolationType.

getControlPointsList

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.v1beta.SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.ControlPoint control_points = 4;

getControlPoints

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.v1beta.SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.ControlPoint control_points = 4;

getControlPointsCount

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.v1beta.SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.ControlPoint control_points = 4;

getControlPointsOrBuilderList

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.v1beta.SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.ControlPoint control_points = 4;

getControlPointsOrBuilder

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.v1beta.SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.ControlPoint control_points = 4;