Class Control.BoostAction.InterpolationBoostSpec.ControlPoint (0.58.0)

public static final class Control.BoostAction.InterpolationBoostSpec.ControlPoint extends GeneratedMessageV3 implements Control.BoostAction.InterpolationBoostSpec.ControlPointOrBuilder

The control points used to define the curve. The curve defined through these control points can only be monotonically increasing or decreasing(constant values are acceptable).

Protobuf type google.cloud.discoveryengine.v1.Control.BoostAction.InterpolationBoostSpec.ControlPoint

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Control.BoostAction.InterpolationBoostSpec.ControlPoint

Static Fields

ATTRIBUTE_VALUE_FIELD_NUMBER

public static final int ATTRIBUTE_VALUE_FIELD_NUMBER
Field Value
Type Description
int

BOOST_AMOUNT_FIELD_NUMBER

public static final int BOOST_AMOUNT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Control.BoostAction.InterpolationBoostSpec.ControlPoint getDefaultInstance()
Returns
Type Description
Control.BoostAction.InterpolationBoostSpec.ControlPoint

getDescriptor()

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

newBuilder()

public static Control.BoostAction.InterpolationBoostSpec.ControlPoint.Builder newBuilder()
Returns
Type Description
Control.BoostAction.InterpolationBoostSpec.ControlPoint.Builder

newBuilder(Control.BoostAction.InterpolationBoostSpec.ControlPoint prototype)

public static Control.BoostAction.InterpolationBoostSpec.ControlPoint.Builder newBuilder(Control.BoostAction.InterpolationBoostSpec.ControlPoint prototype)
Parameter
Name Description
prototype Control.BoostAction.InterpolationBoostSpec.ControlPoint
Returns
Type Description
Control.BoostAction.InterpolationBoostSpec.ControlPoint.Builder

parseDelimitedFrom(InputStream input)

public static Control.BoostAction.InterpolationBoostSpec.ControlPoint parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Control.BoostAction.InterpolationBoostSpec.ControlPoint
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Control.BoostAction.InterpolationBoostSpec.ControlPoint parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Control.BoostAction.InterpolationBoostSpec.ControlPoint
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Control.BoostAction.InterpolationBoostSpec.ControlPoint parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Control.BoostAction.InterpolationBoostSpec.ControlPoint
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Control.BoostAction.InterpolationBoostSpec.ControlPoint parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Control.BoostAction.InterpolationBoostSpec.ControlPoint
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Control.BoostAction.InterpolationBoostSpec.ControlPoint parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Control.BoostAction.InterpolationBoostSpec.ControlPoint
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Control.BoostAction.InterpolationBoostSpec.ControlPoint parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Control.BoostAction.InterpolationBoostSpec.ControlPoint
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Control.BoostAction.InterpolationBoostSpec.ControlPoint parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Control.BoostAction.InterpolationBoostSpec.ControlPoint
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Control.BoostAction.InterpolationBoostSpec.ControlPoint parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Control.BoostAction.InterpolationBoostSpec.ControlPoint
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Control.BoostAction.InterpolationBoostSpec.ControlPoint parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Control.BoostAction.InterpolationBoostSpec.ControlPoint
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Control.BoostAction.InterpolationBoostSpec.ControlPoint parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Control.BoostAction.InterpolationBoostSpec.ControlPoint
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Control.BoostAction.InterpolationBoostSpec.ControlPoint parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Control.BoostAction.InterpolationBoostSpec.ControlPoint
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Control.BoostAction.InterpolationBoostSpec.ControlPoint parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Control.BoostAction.InterpolationBoostSpec.ControlPoint
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Control.BoostAction.InterpolationBoostSpec.ControlPoint> parser()
Returns
Type Description
Parser<ControlPoint>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAttributeValue()

public String getAttributeValue()

Optional. Can be one of:

  1. The numerical field value.
  2. The duration spec for freshness: The value must be formatted as an XSD dayTimeDuration value (a restricted subset of an ISO 8601 duration value). The pattern for this is: nDnM].

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

Returns
Type Description
String

The attributeValue.

getAttributeValueBytes()

public ByteString getAttributeValueBytes()

Optional. Can be one of:

  1. The numerical field value.
  2. The duration spec for freshness: The value must be formatted as an XSD dayTimeDuration value (a restricted subset of an ISO 8601 duration value). The pattern for this is: nDnM].

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

Returns
Type Description
ByteString

The bytes for attributeValue.

getBoostAmount()

public float getBoostAmount()

Optional. The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above.

float boost_amount = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
float

The boostAmount.

getDefaultInstanceForType()

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

getParserForType()

public Parser<Control.BoostAction.InterpolationBoostSpec.ControlPoint> getParserForType()
Returns
Type Description
Parser<ControlPoint>
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 Control.BoostAction.InterpolationBoostSpec.ControlPoint.Builder newBuilderForType()
Returns
Type Description
Control.BoostAction.InterpolationBoostSpec.ControlPoint.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Control.BoostAction.InterpolationBoostSpec.ControlPoint.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Control.BoostAction.InterpolationBoostSpec.ControlPoint.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

public Control.BoostAction.InterpolationBoostSpec.ControlPoint.Builder toBuilder()
Returns
Type Description
Control.BoostAction.InterpolationBoostSpec.ControlPoint.Builder

writeTo(CodedOutputStream output)

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