Class SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.Builder (0.54.0)

public static final class SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.Builder extends GeneratedMessageV3.Builder<SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.Builder> 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.v1.SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.Builder
com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

Static Methods

getDescriptor()

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

Methods

addAllControlPoints(Iterable<? extends SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.ControlPoint> values)

public SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.Builder addAllControlPoints(Iterable<? extends SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.ControlPoint> values)

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

Parameter
Name Description
values Iterable<? extends com.google.cloud.discoveryengine.v1.SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.ControlPoint>

addControlPoints(SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.ControlPoint value)

public SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.Builder addControlPoints(SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.ControlPoint value)

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

addControlPoints(SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.ControlPoint.Builder builderForValue)

public SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.Builder addControlPoints(SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.ControlPoint.Builder builderForValue)

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

addControlPoints(int index, SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.ControlPoint value)

public SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.Builder addControlPoints(int index, SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.ControlPoint value)

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

addControlPoints(int index, SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.ControlPoint.Builder builderForValue)

public SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.Builder addControlPoints(int index, SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.ControlPoint.Builder builderForValue)

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

addControlPointsBuilder()

public SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.ControlPoint.Builder addControlPointsBuilder()

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

addControlPointsBuilder(int index)

public SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.ControlPoint.Builder addControlPointsBuilder(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.v1.SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.ControlPoint control_points = 4;

Parameter
Name Description
index int

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Overrides

build()

public SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec build()

buildPartial()

public SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec buildPartial()

clear()

public SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.Builder clear()
Overrides

clearAttributeType()

public SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.Builder clearAttributeType()

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

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

This builder for chaining.

clearControlPoints()

public SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.Builder clearControlPoints()

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

clearField(Descriptors.FieldDescriptor field)

public SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Overrides

clearFieldName()

public SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.Builder clearFieldName()

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

string field_name = 1;

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

This builder for chaining.

clearInterpolationType()

public SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.Builder clearInterpolationType()

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

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

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

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Overrides

clone()

public SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.Builder clone()
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.v1.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.v1.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.v1.SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.ControlPoint control_points = 4;

Parameter
Name Description
index int

getControlPointsBuilder(int index)

public SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.ControlPoint.Builder getControlPointsBuilder(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.v1.SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.ControlPoint control_points = 4;

Parameter
Name Description
index int

getControlPointsBuilderList()

public List<SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.ControlPoint.Builder> getControlPointsBuilderList()

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

Returns
Type Description
List<Builder>

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

Parameter
Name Description
index int

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

Returns
Type Description
List<? extends com.google.cloud.discoveryengine.v1.SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.ControlPointOrBuilder>

getDefaultInstanceForType()

public SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec getDefaultInstanceForType()

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.v1.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.v1.SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.InterpolationType interpolation_type = 3;

Returns
Type Description
int

The enum numeric value on the wire for interpolationType.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec other)

public SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.Builder mergeFrom(SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec other)

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Overrides

removeControlPoints(int index)

public SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.Builder removeControlPoints(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.v1.SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.ControlPoint control_points = 4;

Parameter
Name Description
index int

setAttributeType(SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.AttributeType value)

public SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.Builder setAttributeType(SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.AttributeType value)

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

Parameter
Name Description
value SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.AttributeType

The attributeType to set.

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

This builder for chaining.

setAttributeTypeValue(int value)

public SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.Builder setAttributeTypeValue(int value)

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

Parameter
Name Description
value int

The enum numeric value on the wire for attributeType to set.

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

This builder for chaining.

setControlPoints(int index, SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.ControlPoint value)

public SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.Builder setControlPoints(int index, SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.ControlPoint value)

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

setControlPoints(int index, SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.ControlPoint.Builder builderForValue)

public SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.Builder setControlPoints(int index, SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.ControlPoint.Builder builderForValue)

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

setField(Descriptors.FieldDescriptor field, Object value)

public SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Overrides

setFieldName(String value)

public SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.Builder setFieldName(String value)

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

string field_name = 1;

Parameter
Name Description
value String

The fieldName to set.

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

This builder for chaining.

setFieldNameBytes(ByteString value)

public SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.Builder setFieldNameBytes(ByteString value)

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

string field_name = 1;

Parameter
Name Description
value ByteString

The bytes for fieldName to set.

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

This builder for chaining.

setInterpolationType(SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.InterpolationType value)

public SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.Builder setInterpolationType(SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.InterpolationType value)

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

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

Parameter
Name Description
value SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.InterpolationType

The interpolationType to set.

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

This builder for chaining.

setInterpolationTypeValue(int value)

public SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.Builder setInterpolationTypeValue(int value)

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

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

Parameter
Name Description
value int

The enum numeric value on the wire for interpolationType to set.

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

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Overrides