com.google.cloud.discoveryengine.v1beta

Class AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderT>

com.google.protobuf.GeneratedMessageV3.Builder<AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec.Builder>

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

All Implemented Interfaces:

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

Enclosing class:

AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec

public static final class AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec.Builder>
implements AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpecOrBuilder

 Boost applies to suggestions which match a condition.
 

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

Method Summary

Modifier and Type	Method and Description
AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec	build()
AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec	buildPartial()
AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec.Builder	clear()
AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec.Builder	clearBoost() Strength of the boost, which should be in [-1, 1].
AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec.Builder	clearCondition() An expression which specifies a boost condition.
AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec.Builder	clone()
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.
AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec.Builder	mergeFrom(AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec other)
AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec.Builder	mergeFrom(com.google.protobuf.Message other)
AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec.Builder	setBoost(float value) Strength of the boost, which should be in [-1, 1].
AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec.Builder	setCondition(String value) An expression which specifies a boost condition.
AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec.Builder	setConditionBytes(com.google.protobuf.ByteString value) An expression which specifies a boost condition.
AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Method Detail

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.Builder<AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec.Builder>

clear

public AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec.Builder>

getDefaultInstanceForType

public AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone

public AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec.Builder clone()

Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec.Builder>

setField

public AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                                                  Object value)

Specified by:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec.Builder>

clearField

public AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec.Builder>

clearOneof

public AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec.Builder>

setRepeatedField

public AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                                                          int index,
                                                                                          Object value)

Specified by:

setRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec.Builder>

addRepeatedField

public AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                                                          Object value)

Specified by:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec.Builder>

mergeFrom

public AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec.Builder>

mergeFrom

public AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec.Builder mergeFrom(AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec.Builder>

mergeFrom

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

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec.Builder>

Throws:

IOException

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.

setCondition

public AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec.Builder setCondition(String value)

 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;

Parameters:

value - The condition to set.

Returns:

This builder for chaining.

clearCondition

public AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec.Builder clearCondition()

 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;

Returns:

This builder for chaining.

setConditionBytes

public AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec.Builder setConditionBytes(com.google.protobuf.ByteString value)

 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;

Parameters:

value - The bytes for condition to set.

Returns:

This builder for chaining.

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.

setBoost

public AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec.Builder setBoost(float value)

 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;

Parameters:

value - The boost to set.

Returns:

This builder for chaining.

clearBoost

public AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec.Builder clearBoost()

 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;

Returns:

This builder for chaining.

setUnknownFields

public final AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec.Builder>

mergeUnknownFields

public final AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec.Builder>