Package com.google.cloud.discoveryengine.v1beta

Class AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessage

com.google.cloud.discoveryengine.v1beta.AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec

All Implemented Interfaces:

AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpecOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

Enclosing class:

AdvancedCompleteQueryRequest.BoostSpec

public static final class AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec
extends com.google.protobuf.GeneratedMessage
implements AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpecOrBuilder

 Boost applies to suggestions which match a condition.
 

Protobuf type google.cloud.discoveryengine.v1beta.AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec.Builder	Boost applies to suggestions which match a condition.

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 extends Object>, 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	Description
static final int	BOOST_FIELD_NUMBER
static final int	CONDITION_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	Description
boolean	equals(Object obj)
float	getBoost()	Strength of the boost, which should be in [-1, 1].
String	getCondition()	An expression which specifies a boost condition.
com.google.protobuf.ByteString	getConditionBytes()	An expression which specifies a boost condition.
static AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec	getDefaultInstance()
AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec	getDefaultInstanceForType()
static final com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Parser<AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec>	getParserForType()
int	getSerializedSize()
int	hashCode()
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
final boolean	isInitialized()
static AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec.Builder	newBuilder()
static AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec.Builder	newBuilder(AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec prototype)
AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec.Builder	newBuilderForType()
protected AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec.Builder	newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
static AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec	parseDelimitedFrom(InputStream input)
static AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec	parseFrom(byte[] data)
static AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec	parseFrom(com.google.protobuf.ByteString data)
static AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec	parseFrom(com.google.protobuf.CodedInputStream input)
static AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec	parseFrom(InputStream input)
static AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec	parseFrom(ByteBuffer data)
static AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec>	parser()
AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec.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.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Field Details

CONDITION_FIELD_NUMBER

public static final int CONDITION_FIELD_NUMBER

See Also:

• Constant Field Values

BOOST_FIELD_NUMBER

public static final int BOOST_FIELD_NUMBER

See Also:

• Constant Field Values

Method Details

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

getCondition

public String getCondition()

 An expression which specifies a boost condition. The syntax is the same
 as [filter expression
 syntax](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata#filter-expression-syntax).
 Currently, the only supported condition is a list of BCP-47 lang codes.

 Example:

 * To boost suggestions in languages `en` or `fr`:
 `(lang_code: ANY("en", "fr"))`
 

string condition = 1;

Specified by:

getCondition in interface AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpecOrBuilder

Returns:

The condition.

getConditionBytes

public com.google.protobuf.ByteString getConditionBytes()

 An expression which specifies a boost condition. The syntax is the same
 as [filter expression
 syntax](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata#filter-expression-syntax).
 Currently, the only supported condition is a list of BCP-47 lang codes.

 Example:

 * To boost suggestions in languages `en` or `fr`:
 `(lang_code: ANY("en", "fr"))`
 

string condition = 1;

Specified by:

getConditionBytes in interface AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpecOrBuilder

Returns:

The bytes for condition.

getBoost

public float getBoost()

 Strength of the boost, which should be in [-1, 1].
 Negative boost means demotion. Default is 0.0.

 Setting to 1.0 gives the suggestions a big promotion. However, it does
 not necessarily mean that the top result will be a boosted suggestion.

 Setting to -1.0 gives the suggestions a big demotion. However, other
 suggestions that are relevant might still be shown.

 Setting to 0.0 means no boost applied. The boosting condition is
 ignored.
 

float boost = 2;

Specified by:

getBoost in interface AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpecOrBuilder

Returns:

The boost.

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec.Builder newBuilder()

newBuilder

public static AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec.Builder newBuilder(AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec prototype)

toBuilder

public AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)

Overrides:

newBuilderForType in class com.google.protobuf.AbstractMessage

getDefaultInstance

public static AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec getDefaultInstance()

parser

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

getParserForType

public com.google.protobuf.Parser<AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec> 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 AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder