com.google.cloud.discoveryengine.v1beta

Class SearchRequest.BoostSpec.ConditionBoostSpec.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

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

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

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

All Implemented Interfaces:

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

Enclosing class:

SearchRequest.BoostSpec.ConditionBoostSpec

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

 Boost applies to documents which match a condition.
 

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

Method Summary

Modifier and Type	Method and Description
SearchRequest.BoostSpec.ConditionBoostSpec.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
SearchRequest.BoostSpec.ConditionBoostSpec	build()
SearchRequest.BoostSpec.ConditionBoostSpec	buildPartial()
SearchRequest.BoostSpec.ConditionBoostSpec.Builder	clear()
SearchRequest.BoostSpec.ConditionBoostSpec.Builder	clearBoost() Strength of the condition boost, which should be in [-1, 1].
SearchRequest.BoostSpec.ConditionBoostSpec.Builder	clearBoostControlSpec() Complex specification for custom ranking based on customer defined attribute value.
SearchRequest.BoostSpec.ConditionBoostSpec.Builder	clearCondition() An expression which specifies a boost condition.
SearchRequest.BoostSpec.ConditionBoostSpec.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
SearchRequest.BoostSpec.ConditionBoostSpec.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
SearchRequest.BoostSpec.ConditionBoostSpec.Builder	clone()
float	getBoost() Strength of the condition boost, which should be in [-1, 1].
SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec	getBoostControlSpec() Complex specification for custom ranking based on customer defined attribute value.
SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.Builder	getBoostControlSpecBuilder() Complex specification for custom ranking based on customer defined attribute value.
SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpecOrBuilder	getBoostControlSpecOrBuilder() Complex specification for custom ranking based on customer defined attribute value.
String	getCondition() An expression which specifies a boost condition.
com.google.protobuf.ByteString	getConditionBytes() An expression which specifies a boost condition.
SearchRequest.BoostSpec.ConditionBoostSpec	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
boolean	hasBoostControlSpec() Complex specification for custom ranking based on customer defined attribute value.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
SearchRequest.BoostSpec.ConditionBoostSpec.Builder	mergeBoostControlSpec(SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec value) Complex specification for custom ranking based on customer defined attribute value.
SearchRequest.BoostSpec.ConditionBoostSpec.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
SearchRequest.BoostSpec.ConditionBoostSpec.Builder	mergeFrom(com.google.protobuf.Message other)
SearchRequest.BoostSpec.ConditionBoostSpec.Builder	mergeFrom(SearchRequest.BoostSpec.ConditionBoostSpec other)
SearchRequest.BoostSpec.ConditionBoostSpec.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
SearchRequest.BoostSpec.ConditionBoostSpec.Builder	setBoost(float value) Strength of the condition boost, which should be in [-1, 1].
SearchRequest.BoostSpec.ConditionBoostSpec.Builder	setBoostControlSpec(SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.Builder builderForValue) Complex specification for custom ranking based on customer defined attribute value.
SearchRequest.BoostSpec.ConditionBoostSpec.Builder	setBoostControlSpec(SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec value) Complex specification for custom ranking based on customer defined attribute value.
SearchRequest.BoostSpec.ConditionBoostSpec.Builder	setCondition(String value) An expression which specifies a boost condition.
SearchRequest.BoostSpec.ConditionBoostSpec.Builder	setConditionBytes(com.google.protobuf.ByteString value) An expression which specifies a boost condition.
SearchRequest.BoostSpec.ConditionBoostSpec.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
SearchRequest.BoostSpec.ConditionBoostSpec.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
SearchRequest.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<SearchRequest.BoostSpec.ConditionBoostSpec.Builder>

clear

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

getDefaultInstanceForType

public SearchRequest.BoostSpec.ConditionBoostSpec getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

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

setField

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

clearField

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

clearOneof

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

setRepeatedField

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

addRepeatedField

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

mergeFrom

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

mergeFrom

public SearchRequest.BoostSpec.ConditionBoostSpec.Builder mergeFrom(SearchRequest.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<SearchRequest.BoostSpec.ConditionBoostSpec.Builder>

mergeFrom

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

Throws:

IOException

getCondition

public String getCondition()

 An expression which specifies a boost condition. The syntax and
 supported fields are the same as a filter expression. See
 [SearchRequest.filter][google.cloud.discoveryengine.v1beta.SearchRequest.filter]
 for detail syntax and limitations.

 Examples:

 * To boost documents with document ID "doc_1" or "doc_2", and
 color "Red" or "Blue":
 `(document_id: ANY("doc_1", "doc_2")) AND (color: ANY("Red", "Blue"))`
 

string condition = 1;

Specified by:

getCondition in interface SearchRequest.BoostSpec.ConditionBoostSpecOrBuilder

Returns:

The condition.

getConditionBytes

public com.google.protobuf.ByteString getConditionBytes()

 An expression which specifies a boost condition. The syntax and
 supported fields are the same as a filter expression. See
 [SearchRequest.filter][google.cloud.discoveryengine.v1beta.SearchRequest.filter]
 for detail syntax and limitations.

 Examples:

 * To boost documents with document ID "doc_1" or "doc_2", and
 color "Red" or "Blue":
 `(document_id: ANY("doc_1", "doc_2")) AND (color: ANY("Red", "Blue"))`
 

string condition = 1;

Specified by:

getConditionBytes in interface SearchRequest.BoostSpec.ConditionBoostSpecOrBuilder

Returns:

The bytes for condition.

setCondition

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

 An expression which specifies a boost condition. The syntax and
 supported fields are the same as a filter expression. See
 [SearchRequest.filter][google.cloud.discoveryengine.v1beta.SearchRequest.filter]
 for detail syntax and limitations.

 Examples:

 * To boost documents with document ID "doc_1" or "doc_2", and
 color "Red" or "Blue":
 `(document_id: ANY("doc_1", "doc_2")) AND (color: ANY("Red", "Blue"))`
 

string condition = 1;

Parameters:

value - The condition to set.

Returns:

This builder for chaining.

clearCondition

public SearchRequest.BoostSpec.ConditionBoostSpec.Builder clearCondition()

 An expression which specifies a boost condition. The syntax and
 supported fields are the same as a filter expression. See
 [SearchRequest.filter][google.cloud.discoveryengine.v1beta.SearchRequest.filter]
 for detail syntax and limitations.

 Examples:

 * To boost documents with document ID "doc_1" or "doc_2", and
 color "Red" or "Blue":
 `(document_id: ANY("doc_1", "doc_2")) AND (color: ANY("Red", "Blue"))`
 

string condition = 1;

Returns:

This builder for chaining.

setConditionBytes

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

 An expression which specifies a boost condition. The syntax and
 supported fields are the same as a filter expression. See
 [SearchRequest.filter][google.cloud.discoveryengine.v1beta.SearchRequest.filter]
 for detail syntax and limitations.

 Examples:

 * To boost documents with document ID "doc_1" or "doc_2", and
 color "Red" or "Blue":
 `(document_id: ANY("doc_1", "doc_2")) AND (color: ANY("Red", "Blue"))`
 

string condition = 1;

Parameters:

value - The bytes for condition to set.

Returns:

This builder for chaining.

getBoost

public float getBoost()

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

 Setting to 1.0 gives the document a big promotion. However, it does
 not necessarily mean that the boosted document will be the top result
 at all times, nor that other documents will be excluded. Results
 could still be shown even when none of them matches the condition.
 And results that are significantly more relevant to the search query
 can still trump your heavily favored but irrelevant documents.

 Setting to -1.0 gives the document a big demotion. However, results
 that are deeply relevant might still be shown. The document will have
 an upstream battle to get a fairly high ranking, but it is not
 blocked out completely.

 Setting to 0.0 means no boost applied. The boosting condition is
 ignored. Only one of the (condition, boost) combination or the
 boost_control_spec below are set. If both are set then the global boost
 is ignored and the more fine-grained boost_control_spec is applied.
 

float boost = 2;

Specified by:

getBoost in interface SearchRequest.BoostSpec.ConditionBoostSpecOrBuilder

Returns:

The boost.

setBoost

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

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

 Setting to 1.0 gives the document a big promotion. However, it does
 not necessarily mean that the boosted document will be the top result
 at all times, nor that other documents will be excluded. Results
 could still be shown even when none of them matches the condition.
 And results that are significantly more relevant to the search query
 can still trump your heavily favored but irrelevant documents.

 Setting to -1.0 gives the document a big demotion. However, results
 that are deeply relevant might still be shown. The document will have
 an upstream battle to get a fairly high ranking, but it is not
 blocked out completely.

 Setting to 0.0 means no boost applied. The boosting condition is
 ignored. Only one of the (condition, boost) combination or the
 boost_control_spec below are set. If both are set then the global boost
 is ignored and the more fine-grained boost_control_spec is applied.
 

float boost = 2;

Parameters:

value - The boost to set.

Returns:

This builder for chaining.

clearBoost

public SearchRequest.BoostSpec.ConditionBoostSpec.Builder clearBoost()

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

 Setting to 1.0 gives the document a big promotion. However, it does
 not necessarily mean that the boosted document will be the top result
 at all times, nor that other documents will be excluded. Results
 could still be shown even when none of them matches the condition.
 And results that are significantly more relevant to the search query
 can still trump your heavily favored but irrelevant documents.

 Setting to -1.0 gives the document a big demotion. However, results
 that are deeply relevant might still be shown. The document will have
 an upstream battle to get a fairly high ranking, but it is not
 blocked out completely.

 Setting to 0.0 means no boost applied. The boosting condition is
 ignored. Only one of the (condition, boost) combination or the
 boost_control_spec below are set. If both are set then the global boost
 is ignored and the more fine-grained boost_control_spec is applied.
 

float boost = 2;

Returns:

This builder for chaining.

hasBoostControlSpec

public boolean hasBoostControlSpec()

 Complex specification for custom ranking based on customer defined
 attribute value.
 

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

Specified by:

hasBoostControlSpec in interface SearchRequest.BoostSpec.ConditionBoostSpecOrBuilder

Returns:

Whether the boostControlSpec field is set.

getBoostControlSpec

public SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec getBoostControlSpec()

 Complex specification for custom ranking based on customer defined
 attribute value.
 

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

Specified by:

getBoostControlSpec in interface SearchRequest.BoostSpec.ConditionBoostSpecOrBuilder

Returns:

The boostControlSpec.

setBoostControlSpec

public SearchRequest.BoostSpec.ConditionBoostSpec.Builder setBoostControlSpec(SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec value)

 Complex specification for custom ranking based on customer defined
 attribute value.
 

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

setBoostControlSpec

public SearchRequest.BoostSpec.ConditionBoostSpec.Builder setBoostControlSpec(SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.Builder builderForValue)

 Complex specification for custom ranking based on customer defined
 attribute value.
 

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

mergeBoostControlSpec

public SearchRequest.BoostSpec.ConditionBoostSpec.Builder mergeBoostControlSpec(SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec value)

 Complex specification for custom ranking based on customer defined
 attribute value.
 

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

clearBoostControlSpec

public SearchRequest.BoostSpec.ConditionBoostSpec.Builder clearBoostControlSpec()

 Complex specification for custom ranking based on customer defined
 attribute value.
 

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

getBoostControlSpecBuilder

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

 Complex specification for custom ranking based on customer defined
 attribute value.
 

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

getBoostControlSpecOrBuilder

public SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpecOrBuilder getBoostControlSpecOrBuilder()

 Complex specification for custom ranking based on customer defined
 attribute value.
 

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

Specified by:

getBoostControlSpecOrBuilder in interface SearchRequest.BoostSpec.ConditionBoostSpecOrBuilder

setUnknownFields

public final SearchRequest.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<SearchRequest.BoostSpec.ConditionBoostSpec.Builder>

mergeUnknownFields

public final SearchRequest.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<SearchRequest.BoostSpec.ConditionBoostSpec.Builder>