Class Control.BoostAction.InterpolationBoostSpec.Builder (0.58.0)

public static final class Control.BoostAction.InterpolationBoostSpec.Builder extends GeneratedMessageV3.Builder<Control.BoostAction.InterpolationBoostSpec.Builder> implements Control.BoostAction.InterpolationBoostSpecOrBuilder

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.Control.BoostAction.InterpolationBoostSpec

Static Methods

getDescriptor()

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

Methods

addAllControlPoints(Iterable<? extends Control.BoostAction.InterpolationBoostSpec.ControlPoint> values)

public Control.BoostAction.InterpolationBoostSpec.Builder addAllControlPoints(Iterable<? extends Control.BoostAction.InterpolationBoostSpec.ControlPoint> values)

Optional. 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.Control.BoostAction.InterpolationBoostSpec.ControlPoint control_points = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
values Iterable<? extends com.google.cloud.discoveryengine.v1.Control.BoostAction.InterpolationBoostSpec.ControlPoint>
Returns
Type Description
Control.BoostAction.InterpolationBoostSpec.Builder

addControlPoints(Control.BoostAction.InterpolationBoostSpec.ControlPoint value)

public Control.BoostAction.InterpolationBoostSpec.Builder addControlPoints(Control.BoostAction.InterpolationBoostSpec.ControlPoint value)

Optional. 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.Control.BoostAction.InterpolationBoostSpec.ControlPoint control_points = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Control.BoostAction.InterpolationBoostSpec.ControlPoint
Returns
Type Description
Control.BoostAction.InterpolationBoostSpec.Builder

addControlPoints(Control.BoostAction.InterpolationBoostSpec.ControlPoint.Builder builderForValue)

public Control.BoostAction.InterpolationBoostSpec.Builder addControlPoints(Control.BoostAction.InterpolationBoostSpec.ControlPoint.Builder builderForValue)

Optional. 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.Control.BoostAction.InterpolationBoostSpec.ControlPoint control_points = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue Control.BoostAction.InterpolationBoostSpec.ControlPoint.Builder
Returns
Type Description
Control.BoostAction.InterpolationBoostSpec.Builder

addControlPoints(int index, Control.BoostAction.InterpolationBoostSpec.ControlPoint value)

public Control.BoostAction.InterpolationBoostSpec.Builder addControlPoints(int index, Control.BoostAction.InterpolationBoostSpec.ControlPoint value)

Optional. 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.Control.BoostAction.InterpolationBoostSpec.ControlPoint control_points = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
value Control.BoostAction.InterpolationBoostSpec.ControlPoint
Returns
Type Description
Control.BoostAction.InterpolationBoostSpec.Builder

addControlPoints(int index, Control.BoostAction.InterpolationBoostSpec.ControlPoint.Builder builderForValue)

public Control.BoostAction.InterpolationBoostSpec.Builder addControlPoints(int index, Control.BoostAction.InterpolationBoostSpec.ControlPoint.Builder builderForValue)

Optional. 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.Control.BoostAction.InterpolationBoostSpec.ControlPoint control_points = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
builderForValue Control.BoostAction.InterpolationBoostSpec.ControlPoint.Builder
Returns
Type Description
Control.BoostAction.InterpolationBoostSpec.Builder

addControlPointsBuilder()

public Control.BoostAction.InterpolationBoostSpec.ControlPoint.Builder addControlPointsBuilder()

Optional. 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.Control.BoostAction.InterpolationBoostSpec.ControlPoint control_points = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Control.BoostAction.InterpolationBoostSpec.ControlPoint.Builder

addControlPointsBuilder(int index)

public Control.BoostAction.InterpolationBoostSpec.ControlPoint.Builder addControlPointsBuilder(int index)

Optional. 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.Control.BoostAction.InterpolationBoostSpec.ControlPoint control_points = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
Control.BoostAction.InterpolationBoostSpec.ControlPoint.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Control.BoostAction.InterpolationBoostSpec.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Control.BoostAction.InterpolationBoostSpec.Builder
Overrides

build()

public Control.BoostAction.InterpolationBoostSpec build()
Returns
Type Description
Control.BoostAction.InterpolationBoostSpec

buildPartial()

public Control.BoostAction.InterpolationBoostSpec buildPartial()
Returns
Type Description
Control.BoostAction.InterpolationBoostSpec

clear()

public Control.BoostAction.InterpolationBoostSpec.Builder clear()
Returns
Type Description
Control.BoostAction.InterpolationBoostSpec.Builder
Overrides

clearAttributeType()

public Control.BoostAction.InterpolationBoostSpec.Builder clearAttributeType()

Optional. 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.Control.BoostAction.InterpolationBoostSpec.AttributeType attribute_type = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Control.BoostAction.InterpolationBoostSpec.Builder

This builder for chaining.

clearControlPoints()

public Control.BoostAction.InterpolationBoostSpec.Builder clearControlPoints()

Optional. 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.Control.BoostAction.InterpolationBoostSpec.ControlPoint control_points = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Control.BoostAction.InterpolationBoostSpec.Builder

clearField(Descriptors.FieldDescriptor field)

public Control.BoostAction.InterpolationBoostSpec.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Control.BoostAction.InterpolationBoostSpec.Builder
Overrides

clearFieldName()

public Control.BoostAction.InterpolationBoostSpec.Builder clearFieldName()

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

string field_name = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Control.BoostAction.InterpolationBoostSpec.Builder

This builder for chaining.

clearInterpolationType()

public Control.BoostAction.InterpolationBoostSpec.Builder clearInterpolationType()

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

.google.cloud.discoveryengine.v1.Control.BoostAction.InterpolationBoostSpec.InterpolationType interpolation_type = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Control.BoostAction.InterpolationBoostSpec.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Control.BoostAction.InterpolationBoostSpec.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Control.BoostAction.InterpolationBoostSpec.Builder
Overrides

clone()

public Control.BoostAction.InterpolationBoostSpec.Builder clone()
Returns
Type Description
Control.BoostAction.InterpolationBoostSpec.Builder
Overrides

getAttributeType()

public Control.BoostAction.InterpolationBoostSpec.AttributeType getAttributeType()

Optional. 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.Control.BoostAction.InterpolationBoostSpec.AttributeType attribute_type = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Control.BoostAction.InterpolationBoostSpec.AttributeType

The attributeType.

getAttributeTypeValue()

public int getAttributeTypeValue()

Optional. 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.Control.BoostAction.InterpolationBoostSpec.AttributeType attribute_type = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for attributeType.

getControlPoints(int index)

public Control.BoostAction.InterpolationBoostSpec.ControlPoint getControlPoints(int index)

Optional. 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.Control.BoostAction.InterpolationBoostSpec.ControlPoint control_points = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
Control.BoostAction.InterpolationBoostSpec.ControlPoint

getControlPointsBuilder(int index)

public Control.BoostAction.InterpolationBoostSpec.ControlPoint.Builder getControlPointsBuilder(int index)

Optional. 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.Control.BoostAction.InterpolationBoostSpec.ControlPoint control_points = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
Control.BoostAction.InterpolationBoostSpec.ControlPoint.Builder

getControlPointsBuilderList()

public List<Control.BoostAction.InterpolationBoostSpec.ControlPoint.Builder> getControlPointsBuilderList()

Optional. 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.Control.BoostAction.InterpolationBoostSpec.ControlPoint control_points = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<Builder>

getControlPointsCount()

public int getControlPointsCount()

Optional. 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.Control.BoostAction.InterpolationBoostSpec.ControlPoint control_points = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getControlPointsList()

public List<Control.BoostAction.InterpolationBoostSpec.ControlPoint> getControlPointsList()

Optional. 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.Control.BoostAction.InterpolationBoostSpec.ControlPoint control_points = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<ControlPoint>

getControlPointsOrBuilder(int index)

public Control.BoostAction.InterpolationBoostSpec.ControlPointOrBuilder getControlPointsOrBuilder(int index)

Optional. 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.Control.BoostAction.InterpolationBoostSpec.ControlPoint control_points = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
Control.BoostAction.InterpolationBoostSpec.ControlPointOrBuilder

getControlPointsOrBuilderList()

public List<? extends Control.BoostAction.InterpolationBoostSpec.ControlPointOrBuilder> getControlPointsOrBuilderList()

Optional. 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.Control.BoostAction.InterpolationBoostSpec.ControlPoint control_points = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.cloud.discoveryengine.v1.Control.BoostAction.InterpolationBoostSpec.ControlPointOrBuilder>

getDefaultInstanceForType()

public Control.BoostAction.InterpolationBoostSpec getDefaultInstanceForType()
Returns
Type Description
Control.BoostAction.InterpolationBoostSpec

getDescriptorForType()

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

getFieldName()

public String getFieldName()

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

string field_name = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The fieldName.

getFieldNameBytes()

public ByteString getFieldNameBytes()

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

string field_name = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for fieldName.

getInterpolationType()

public Control.BoostAction.InterpolationBoostSpec.InterpolationType getInterpolationType()

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

.google.cloud.discoveryengine.v1.Control.BoostAction.InterpolationBoostSpec.InterpolationType interpolation_type = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Control.BoostAction.InterpolationBoostSpec.InterpolationType

The interpolationType.

getInterpolationTypeValue()

public int getInterpolationTypeValue()

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

.google.cloud.discoveryengine.v1.Control.BoostAction.InterpolationBoostSpec.InterpolationType interpolation_type = 3 [(.google.api.field_behavior) = OPTIONAL];

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(Control.BoostAction.InterpolationBoostSpec other)

public Control.BoostAction.InterpolationBoostSpec.Builder mergeFrom(Control.BoostAction.InterpolationBoostSpec other)
Parameter
Name Description
other Control.BoostAction.InterpolationBoostSpec
Returns
Type Description
Control.BoostAction.InterpolationBoostSpec.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Control.BoostAction.InterpolationBoostSpec.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Control.BoostAction.InterpolationBoostSpec.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Control.BoostAction.InterpolationBoostSpec.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Control.BoostAction.InterpolationBoostSpec.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Control.BoostAction.InterpolationBoostSpec.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Control.BoostAction.InterpolationBoostSpec.Builder
Overrides

removeControlPoints(int index)

public Control.BoostAction.InterpolationBoostSpec.Builder removeControlPoints(int index)

Optional. 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.Control.BoostAction.InterpolationBoostSpec.ControlPoint control_points = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
Control.BoostAction.InterpolationBoostSpec.Builder

setAttributeType(Control.BoostAction.InterpolationBoostSpec.AttributeType value)

public Control.BoostAction.InterpolationBoostSpec.Builder setAttributeType(Control.BoostAction.InterpolationBoostSpec.AttributeType value)

Optional. 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.Control.BoostAction.InterpolationBoostSpec.AttributeType attribute_type = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Control.BoostAction.InterpolationBoostSpec.AttributeType

The attributeType to set.

Returns
Type Description
Control.BoostAction.InterpolationBoostSpec.Builder

This builder for chaining.

setAttributeTypeValue(int value)

public Control.BoostAction.InterpolationBoostSpec.Builder setAttributeTypeValue(int value)

Optional. 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.Control.BoostAction.InterpolationBoostSpec.AttributeType attribute_type = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value int

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

Returns
Type Description
Control.BoostAction.InterpolationBoostSpec.Builder

This builder for chaining.

setControlPoints(int index, Control.BoostAction.InterpolationBoostSpec.ControlPoint value)

public Control.BoostAction.InterpolationBoostSpec.Builder setControlPoints(int index, Control.BoostAction.InterpolationBoostSpec.ControlPoint value)

Optional. 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.Control.BoostAction.InterpolationBoostSpec.ControlPoint control_points = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
value Control.BoostAction.InterpolationBoostSpec.ControlPoint
Returns
Type Description
Control.BoostAction.InterpolationBoostSpec.Builder

setControlPoints(int index, Control.BoostAction.InterpolationBoostSpec.ControlPoint.Builder builderForValue)

public Control.BoostAction.InterpolationBoostSpec.Builder setControlPoints(int index, Control.BoostAction.InterpolationBoostSpec.ControlPoint.Builder builderForValue)

Optional. 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.Control.BoostAction.InterpolationBoostSpec.ControlPoint control_points = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
builderForValue Control.BoostAction.InterpolationBoostSpec.ControlPoint.Builder
Returns
Type Description
Control.BoostAction.InterpolationBoostSpec.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public Control.BoostAction.InterpolationBoostSpec.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Control.BoostAction.InterpolationBoostSpec.Builder
Overrides

setFieldName(String value)

public Control.BoostAction.InterpolationBoostSpec.Builder setFieldName(String value)

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

string field_name = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The fieldName to set.

Returns
Type Description
Control.BoostAction.InterpolationBoostSpec.Builder

This builder for chaining.

setFieldNameBytes(ByteString value)

public Control.BoostAction.InterpolationBoostSpec.Builder setFieldNameBytes(ByteString value)

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

string field_name = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for fieldName to set.

Returns
Type Description
Control.BoostAction.InterpolationBoostSpec.Builder

This builder for chaining.

setInterpolationType(Control.BoostAction.InterpolationBoostSpec.InterpolationType value)

public Control.BoostAction.InterpolationBoostSpec.Builder setInterpolationType(Control.BoostAction.InterpolationBoostSpec.InterpolationType value)

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

.google.cloud.discoveryengine.v1.Control.BoostAction.InterpolationBoostSpec.InterpolationType interpolation_type = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Control.BoostAction.InterpolationBoostSpec.InterpolationType

The interpolationType to set.

Returns
Type Description
Control.BoostAction.InterpolationBoostSpec.Builder

This builder for chaining.

setInterpolationTypeValue(int value)

public Control.BoostAction.InterpolationBoostSpec.Builder setInterpolationTypeValue(int value)

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

.google.cloud.discoveryengine.v1.Control.BoostAction.InterpolationBoostSpec.InterpolationType interpolation_type = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value int

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

Returns
Type Description
Control.BoostAction.InterpolationBoostSpec.Builder

This builder for chaining.

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

public Control.BoostAction.InterpolationBoostSpec.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Control.BoostAction.InterpolationBoostSpec.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final Control.BoostAction.InterpolationBoostSpec.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Control.BoostAction.InterpolationBoostSpec.Builder
Overrides