Class SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec (0.42.0)

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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec

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()
Returns
Type Description
SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.Builder newBuilder()
Returns
Type Description
SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.Builder

newBuilder(SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec prototype)

public static SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.Builder newBuilder(SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec prototype)
Parameter
Name Description
prototype SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec
Returns
Type Description
SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.Builder

parseDelimitedFrom(InputStream input)

public static SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec> parser()
Returns
Type Description
Parser<BoostControlSpec>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
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;

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

The attributeType.

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
index int
Returns
Type Description
SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.ControlPoint

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;

Returns
Type Description
List<ControlPoint>

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
index int
Returns
Type Description
SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.ControlPointOrBuilder

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()
Returns
Type Description
SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec

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;

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

The interpolationType.

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()
Returns
Type Description
Parser<BoostControlSpec>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.Builder newBuilderForType()
Returns
Type Description
SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.Builder toBuilder()
Returns
Type Description
SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException