com.google.cloud.discoveryengine.v1beta

Class SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.discoveryengine.v1beta.SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec

All Implemented Interfaces:

SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpecOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

Enclosing class:

SearchRequest.BoostSpec.ConditionBoostSpec

public static final class SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec
extends com.google.protobuf.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.v1beta.SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

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

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

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.GeneratedMessageV3

alwaysUseFieldBuilders, 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)
SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.AttributeType	getAttributeType() The attribute type to be used to determine the boost amount.
int	getAttributeTypeValue() The attribute type to be used to determine the boost amount.
SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.ControlPoint	getControlPoints(int index) The control points used to define the curve.
int	getControlPointsCount() The control points used to define the curve.
List<SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.ControlPoint>	getControlPointsList() The control points used to define the curve.
SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.ControlPointOrBuilder	getControlPointsOrBuilder(int index) The control points used to define the curve.
List<? extends SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.ControlPointOrBuilder>	getControlPointsOrBuilderList() The control points used to define the curve.
static SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec	getDefaultInstance()
SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getFieldName() The name of the field whose value will be used to determine the boost amount.
com.google.protobuf.ByteString	getFieldNameBytes() The name of the field whose value will be used to determine the boost amount.
SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.InterpolationType	getInterpolationType() The interpolation type to be applied to connect the control points listed below.
int	getInterpolationTypeValue() The interpolation type to be applied to connect the control points listed below.
com.google.protobuf.Parser<SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec>	getParserForType()
int	getSerializedSize()
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.Builder	newBuilder()
static SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.Builder	newBuilder(SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec prototype)
SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.Builder	newBuilderForType()
protected SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec	parseDelimitedFrom(InputStream input)
static SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec	parseFrom(byte[] data)
static SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec	parseFrom(ByteBuffer data)
static SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec	parseFrom(com.google.protobuf.ByteString data)
static SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec	parseFrom(com.google.protobuf.CodedInputStream input)
static SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec	parseFrom(InputStream input)
static SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec>	parser()
SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

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, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, 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, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, 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

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

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

internalGetFieldAccessorTable

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

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getFieldName

public String getFieldName()

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

string field_name = 1;

Specified by:

getFieldName in interface SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpecOrBuilder

Returns:

The fieldName.

getFieldNameBytes

public com.google.protobuf.ByteString getFieldNameBytes()

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

string field_name = 1;

Specified by:

getFieldNameBytes in interface SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpecOrBuilder

Returns:

The bytes for fieldName.

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

Specified by:

getAttributeTypeValue in interface SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpecOrBuilder

Returns:

The enum numeric value on the wire for attributeType.

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

Specified by:

getAttributeType in interface SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpecOrBuilder

Returns:

The attributeType.

getInterpolationTypeValue

public int getInterpolationTypeValue()

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

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

Specified by:

getInterpolationTypeValue in interface SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpecOrBuilder

Returns:

The enum numeric value on the wire for interpolationType.

getInterpolationType

public SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.InterpolationType getInterpolationType()

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

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

Specified by:

getInterpolationType in interface SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpecOrBuilder

Returns:

The interpolationType.

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

Specified by:

getControlPointsList in interface SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpecOrBuilder

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

Specified by:

getControlPointsOrBuilderList in interface SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpecOrBuilder

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

Specified by:

getControlPointsCount in interface SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpecOrBuilder

getControlPoints

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

Specified by:

getControlPoints in interface SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpecOrBuilder

getControlPointsOrBuilder

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

Specified by:

getControlPointsOrBuilder in interface SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpecOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

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.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

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 SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec parseFrom(ByteBuffer data)
                                                                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec parseFrom(ByteBuffer data,
                                                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec parseFrom(com.google.protobuf.ByteString data)
                                                                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec parseFrom(com.google.protobuf.ByteString data,
                                                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec parseFrom(byte[] data)
                                                                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec parseFrom(byte[] data,
                                                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec parseFrom(InputStream input)
                                                                             throws IOException

Throws:

IOException

parseFrom

public static SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec parseFrom(InputStream input,
                                                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                             throws IOException

Throws:

IOException

parseDelimitedFrom

public static SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec parseDelimitedFrom(InputStream input)
                                                                                      throws IOException

Throws:

IOException

parseDelimitedFrom

public static SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec parseDelimitedFrom(InputStream input,
                                                                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                                      throws IOException

Throws:

IOException

parseFrom

public static SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec parseFrom(com.google.protobuf.CodedInputStream input)
                                                                             throws IOException

Throws:

IOException

parseFrom

public static SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec parseFrom(com.google.protobuf.CodedInputStream input,
                                                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                             throws IOException

Throws:

IOException

newBuilderForType

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

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.Builder newBuilder()

newBuilder

public static SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.Builder newBuilder(SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec prototype)

toBuilder

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

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec getDefaultInstance()

parser

public static com.google.protobuf.Parser<SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec> parser()

getParserForType

public com.google.protobuf.Parser<SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec> 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.GeneratedMessageV3

getDefaultInstanceForType

public SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder