com.google.cloud.discoveryengine.v1

Class Control.BoostAction.InterpolationBoostSpec

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessage

com.google.cloud.discoveryengine.v1.Control.BoostAction.InterpolationBoostSpec

All Implemented Interfaces:

Control.BoostAction.InterpolationBoostSpecOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

Enclosing class:

Control.BoostAction

public static final class Control.BoostAction.InterpolationBoostSpec
extends com.google.protobuf.GeneratedMessage
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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Control.BoostAction.InterpolationBoostSpec.AttributeType The attribute(or function) for which the custom ranking is to be applied.
static class	Control.BoostAction.InterpolationBoostSpec.Builder Specification for custom ranking based on customer specified attribute value.
static class	Control.BoostAction.InterpolationBoostSpec.ControlPoint The control points used to define the curve.
static interface	Control.BoostAction.InterpolationBoostSpec.ControlPointOrBuilder
static class	Control.BoostAction.InterpolationBoostSpec.InterpolationType The interpolation type to be applied.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

com.google.protobuf.AbstractMessage.BuilderParent

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	ATTRIBUTE_TYPE_FIELD_NUMBER
static int	CONTROL_POINTS_FIELD_NUMBER
static int	FIELD_NAME_FIELD_NUMBER
static int	INTERPOLATION_TYPE_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessage

alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Control.BoostAction.InterpolationBoostSpec.AttributeType	getAttributeType() Optional.
int	getAttributeTypeValue() Optional.
Control.BoostAction.InterpolationBoostSpec.ControlPoint	getControlPoints(int index) Optional.
int	getControlPointsCount() Optional.
List<Control.BoostAction.InterpolationBoostSpec.ControlPoint>	getControlPointsList() Optional.
Control.BoostAction.InterpolationBoostSpec.ControlPointOrBuilder	getControlPointsOrBuilder(int index) Optional.
List<? extends Control.BoostAction.InterpolationBoostSpec.ControlPointOrBuilder>	getControlPointsOrBuilderList() Optional.
static Control.BoostAction.InterpolationBoostSpec	getDefaultInstance()
Control.BoostAction.InterpolationBoostSpec	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getFieldName() Optional.
com.google.protobuf.ByteString	getFieldNameBytes() Optional.
Control.BoostAction.InterpolationBoostSpec.InterpolationType	getInterpolationType() Optional.
int	getInterpolationTypeValue() Optional.
com.google.protobuf.Parser<Control.BoostAction.InterpolationBoostSpec>	getParserForType()
int	getSerializedSize()
int	hashCode()
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static Control.BoostAction.InterpolationBoostSpec.Builder	newBuilder()
static Control.BoostAction.InterpolationBoostSpec.Builder	newBuilder(Control.BoostAction.InterpolationBoostSpec prototype)
Control.BoostAction.InterpolationBoostSpec.Builder	newBuilderForType()
protected Control.BoostAction.InterpolationBoostSpec.Builder	newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
static Control.BoostAction.InterpolationBoostSpec	parseDelimitedFrom(InputStream input)
static Control.BoostAction.InterpolationBoostSpec	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Control.BoostAction.InterpolationBoostSpec	parseFrom(byte[] data)
static Control.BoostAction.InterpolationBoostSpec	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Control.BoostAction.InterpolationBoostSpec	parseFrom(ByteBuffer data)
static Control.BoostAction.InterpolationBoostSpec	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Control.BoostAction.InterpolationBoostSpec	parseFrom(com.google.protobuf.ByteString data)
static Control.BoostAction.InterpolationBoostSpec	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Control.BoostAction.InterpolationBoostSpec	parseFrom(com.google.protobuf.CodedInputStream input)
static Control.BoostAction.InterpolationBoostSpec	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Control.BoostAction.InterpolationBoostSpec	parseFrom(InputStream input)
static Control.BoostAction.InterpolationBoostSpec	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Control.BoostAction.InterpolationBoostSpec>	parser()
Control.BoostAction.InterpolationBoostSpec.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessage

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashFields, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

FIELD_NAME_FIELD_NUMBER

public static final int FIELD_NAME_FIELD_NUMBER

See Also:

Constant Field Values

ATTRIBUTE_TYPE_FIELD_NUMBER

public static final int ATTRIBUTE_TYPE_FIELD_NUMBER

See Also:

Constant Field Values

INTERPOLATION_TYPE_FIELD_NUMBER

public static final int INTERPOLATION_TYPE_FIELD_NUMBER

See Also:

Constant Field Values

CONTROL_POINTS_FIELD_NUMBER

public static final int CONTROL_POINTS_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

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];

Specified by:

getFieldName in interface Control.BoostAction.InterpolationBoostSpecOrBuilder

Returns:

The fieldName.

getFieldNameBytes

public com.google.protobuf.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];

Specified by:

getFieldNameBytes in interface Control.BoostAction.InterpolationBoostSpecOrBuilder

Returns:

The bytes for fieldName.

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];

Specified by:

getAttributeTypeValue in interface Control.BoostAction.InterpolationBoostSpecOrBuilder

Returns:

The enum numeric value on the wire for attributeType.

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];

Specified by:

getAttributeType in interface Control.BoostAction.InterpolationBoostSpecOrBuilder

Returns:

The attributeType.

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];

Specified by:

getInterpolationTypeValue in interface Control.BoostAction.InterpolationBoostSpecOrBuilder

Returns:

The enum numeric value on the wire for interpolationType.

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];

Specified by:

getInterpolationType in interface Control.BoostAction.InterpolationBoostSpecOrBuilder

Returns:

The interpolationType.

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];

Specified by:

getControlPointsList in interface Control.BoostAction.InterpolationBoostSpecOrBuilder

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];

Specified by:

getControlPointsOrBuilderList in interface Control.BoostAction.InterpolationBoostSpecOrBuilder

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];

Specified by:

getControlPointsCount in interface Control.BoostAction.InterpolationBoostSpecOrBuilder

getControlPoints

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];

Specified by:

getControlPoints in interface Control.BoostAction.InterpolationBoostSpecOrBuilder

getControlPointsOrBuilder

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];

Specified by:

getControlPointsOrBuilder in interface Control.BoostAction.InterpolationBoostSpecOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessage

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessage

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessage

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static Control.BoostAction.InterpolationBoostSpec parseFrom(ByteBuffer data)
                                                            throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Control.BoostAction.InterpolationBoostSpec parseFrom(ByteBuffer data,
                                                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                            throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Control.BoostAction.InterpolationBoostSpec parseFrom(com.google.protobuf.ByteString data)
                                                            throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Control.BoostAction.InterpolationBoostSpec parseFrom(com.google.protobuf.ByteString data,
                                                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                            throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Control.BoostAction.InterpolationBoostSpec parseFrom(byte[] data)
                                                            throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Control.BoostAction.InterpolationBoostSpec parseFrom(byte[] data,
                                                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                            throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Control.BoostAction.InterpolationBoostSpec parseFrom(InputStream input)
                                                            throws IOException

Throws:

IOException

parseFrom

public static Control.BoostAction.InterpolationBoostSpec parseFrom(InputStream input,
                                                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                            throws IOException

Throws:

IOException

parseDelimitedFrom

public static Control.BoostAction.InterpolationBoostSpec parseDelimitedFrom(InputStream input)
                                                                     throws IOException

Throws:

IOException

parseDelimitedFrom

public static Control.BoostAction.InterpolationBoostSpec parseDelimitedFrom(InputStream input,
                                                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                     throws IOException

Throws:

IOException

parseFrom

public static Control.BoostAction.InterpolationBoostSpec parseFrom(com.google.protobuf.CodedInputStream input)
                                                            throws IOException

Throws:

IOException

parseFrom

public static Control.BoostAction.InterpolationBoostSpec parseFrom(com.google.protobuf.CodedInputStream input,
                                                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                            throws IOException

Throws:

IOException

newBuilderForType

public Control.BoostAction.InterpolationBoostSpec.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static Control.BoostAction.InterpolationBoostSpec.Builder newBuilder()

newBuilder

public static Control.BoostAction.InterpolationBoostSpec.Builder newBuilder(Control.BoostAction.InterpolationBoostSpec prototype)

toBuilder

public Control.BoostAction.InterpolationBoostSpec.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected Control.BoostAction.InterpolationBoostSpec.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)

Overrides:

newBuilderForType in class com.google.protobuf.AbstractMessage

getDefaultInstance

public static Control.BoostAction.InterpolationBoostSpec getDefaultInstance()

parser

public static com.google.protobuf.Parser<Control.BoostAction.InterpolationBoostSpec> parser()

getParserForType

public com.google.protobuf.Parser<Control.BoostAction.InterpolationBoostSpec> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessage

getDefaultInstanceForType

public Control.BoostAction.InterpolationBoostSpec getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder