Package com.google.cloud.dialogflow.v2

Class SearchKnowledgeRequest.SearchConfig.BoostSpecs.BoostSpec.ConditionBoostSpec.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

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

com.google.protobuf.GeneratedMessage.Builder<SearchKnowledgeRequest.SearchConfig.BoostSpecs.BoostSpec.ConditionBoostSpec.Builder>

com.google.cloud.dialogflow.v2.SearchKnowledgeRequest.SearchConfig.BoostSpecs.BoostSpec.ConditionBoostSpec.Builder

All Implemented Interfaces:

SearchKnowledgeRequest.SearchConfig.BoostSpecs.BoostSpec.ConditionBoostSpecOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

SearchKnowledgeRequest.SearchConfig.BoostSpecs.BoostSpec.ConditionBoostSpec

public static final class SearchKnowledgeRequest.SearchConfig.BoostSpecs.BoostSpec.ConditionBoostSpec.Builder
extends com.google.protobuf.GeneratedMessage.Builder<SearchKnowledgeRequest.SearchConfig.BoostSpecs.BoostSpec.ConditionBoostSpec.Builder>
implements SearchKnowledgeRequest.SearchConfig.BoostSpecs.BoostSpec.ConditionBoostSpecOrBuilder

 Boost applies to documents which match a condition.
 

Protobuf type google.cloud.dialogflow.v2.SearchKnowledgeRequest.SearchConfig.BoostSpecs.BoostSpec.ConditionBoostSpec

Method Summary

Modifier and Type	Method	Description
SearchKnowledgeRequest.SearchConfig.BoostSpecs.BoostSpec.ConditionBoostSpec	build()
SearchKnowledgeRequest.SearchConfig.BoostSpecs.BoostSpec.ConditionBoostSpec	buildPartial()
SearchKnowledgeRequest.SearchConfig.BoostSpecs.BoostSpec.ConditionBoostSpec.Builder	clear()
SearchKnowledgeRequest.SearchConfig.BoostSpecs.BoostSpec.ConditionBoostSpec.Builder	clearBoost()	Optional.
SearchKnowledgeRequest.SearchConfig.BoostSpecs.BoostSpec.ConditionBoostSpec.Builder	clearBoostControlSpec()	Optional.
SearchKnowledgeRequest.SearchConfig.BoostSpecs.BoostSpec.ConditionBoostSpec.Builder	clearCondition()	Optional.
float	getBoost()	Optional.
SearchKnowledgeRequest.SearchConfig.BoostSpecs.BoostSpec.ConditionBoostSpec.BoostControlSpec	getBoostControlSpec()	Optional.
SearchKnowledgeRequest.SearchConfig.BoostSpecs.BoostSpec.ConditionBoostSpec.BoostControlSpec.Builder	getBoostControlSpecBuilder()	Optional.
SearchKnowledgeRequest.SearchConfig.BoostSpecs.BoostSpec.ConditionBoostSpec.BoostControlSpecOrBuilder	getBoostControlSpecOrBuilder()	Optional.
String	getCondition()	Optional.
com.google.protobuf.ByteString	getConditionBytes()	Optional.
SearchKnowledgeRequest.SearchConfig.BoostSpecs.BoostSpec.ConditionBoostSpec	getDefaultInstanceForType()
static final com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
boolean	hasBoostControlSpec()	Optional.
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
final boolean	isInitialized()
SearchKnowledgeRequest.SearchConfig.BoostSpecs.BoostSpec.ConditionBoostSpec.Builder	mergeBoostControlSpec(SearchKnowledgeRequest.SearchConfig.BoostSpecs.BoostSpec.ConditionBoostSpec.BoostControlSpec value)	Optional.
SearchKnowledgeRequest.SearchConfig.BoostSpecs.BoostSpec.ConditionBoostSpec.Builder	mergeFrom(SearchKnowledgeRequest.SearchConfig.BoostSpecs.BoostSpec.ConditionBoostSpec other)
SearchKnowledgeRequest.SearchConfig.BoostSpecs.BoostSpec.ConditionBoostSpec.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
SearchKnowledgeRequest.SearchConfig.BoostSpecs.BoostSpec.ConditionBoostSpec.Builder	mergeFrom(com.google.protobuf.Message other)
SearchKnowledgeRequest.SearchConfig.BoostSpecs.BoostSpec.ConditionBoostSpec.Builder	setBoost(float value)	Optional.
SearchKnowledgeRequest.SearchConfig.BoostSpecs.BoostSpec.ConditionBoostSpec.Builder	setBoostControlSpec(SearchKnowledgeRequest.SearchConfig.BoostSpecs.BoostSpec.ConditionBoostSpec.BoostControlSpec value)	Optional.
SearchKnowledgeRequest.SearchConfig.BoostSpecs.BoostSpec.ConditionBoostSpec.Builder	setBoostControlSpec(SearchKnowledgeRequest.SearchConfig.BoostSpecs.BoostSpec.ConditionBoostSpec.BoostControlSpec.Builder builderForValue)	Optional.
SearchKnowledgeRequest.SearchConfig.BoostSpecs.BoostSpec.ConditionBoostSpec.Builder	setCondition(String value)	Optional.
SearchKnowledgeRequest.SearchConfig.BoostSpecs.BoostSpec.ConditionBoostSpec.Builder	setConditionBytes(com.google.protobuf.ByteString value)	Optional.

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

addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, 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, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

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

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

mergeDelimitedFrom, mergeDelimitedFrom

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

mergeFrom

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

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.Builder<SearchKnowledgeRequest.SearchConfig.BoostSpecs.BoostSpec.ConditionBoostSpec.Builder>

clear

public SearchKnowledgeRequest.SearchConfig.BoostSpecs.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.GeneratedMessage.Builder<SearchKnowledgeRequest.SearchConfig.BoostSpecs.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.GeneratedMessage.Builder<SearchKnowledgeRequest.SearchConfig.BoostSpecs.BoostSpec.ConditionBoostSpec.Builder>

getDefaultInstanceForType

public SearchKnowledgeRequest.SearchConfig.BoostSpecs.BoostSpec.ConditionBoostSpec getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public SearchKnowledgeRequest.SearchConfig.BoostSpecs.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 SearchKnowledgeRequest.SearchConfig.BoostSpecs.BoostSpec.ConditionBoostSpec buildPartial()

Specified by:

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

Specified by:

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

mergeFrom

public SearchKnowledgeRequest.SearchConfig.BoostSpecs.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<SearchKnowledgeRequest.SearchConfig.BoostSpecs.BoostSpec.ConditionBoostSpec.Builder>

mergeFrom

public SearchKnowledgeRequest.SearchConfig.BoostSpecs.BoostSpec.ConditionBoostSpec.Builder mergeFrom(SearchKnowledgeRequest.SearchConfig.BoostSpecs.BoostSpec.ConditionBoostSpec other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessage.Builder<SearchKnowledgeRequest.SearchConfig.BoostSpecs.BoostSpec.ConditionBoostSpec.Builder>

mergeFrom

public SearchKnowledgeRequest.SearchConfig.BoostSpecs.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<SearchKnowledgeRequest.SearchConfig.BoostSpecs.BoostSpec.ConditionBoostSpec.Builder>

Throws:

IOException

getCondition

public String getCondition()

 Optional. An expression which specifies a boost condition. The
 syntax and supported fields are the same as a filter expression.
 Examples:

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

string condition = 1 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getCondition in interface SearchKnowledgeRequest.SearchConfig.BoostSpecs.BoostSpec.ConditionBoostSpecOrBuilder

Returns:

The condition.

getConditionBytes

public com.google.protobuf.ByteString getConditionBytes()

 Optional. An expression which specifies a boost condition. The
 syntax and supported fields are the same as a filter expression.
 Examples:

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

string condition = 1 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getConditionBytes in interface SearchKnowledgeRequest.SearchConfig.BoostSpecs.BoostSpec.ConditionBoostSpecOrBuilder

Returns:

The bytes for condition.

setCondition

public SearchKnowledgeRequest.SearchConfig.BoostSpecs.BoostSpec.ConditionBoostSpec.Builder setCondition(String value)

 Optional. An expression which specifies a boost condition. The
 syntax and supported fields are the same as a filter expression.
 Examples:

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

string condition = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameters:

value - The condition to set.

Returns:

This builder for chaining.

clearCondition

public SearchKnowledgeRequest.SearchConfig.BoostSpecs.BoostSpec.ConditionBoostSpec.Builder clearCondition()

 Optional. An expression which specifies a boost condition. The
 syntax and supported fields are the same as a filter expression.
 Examples:

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

string condition = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns:

This builder for chaining.

setConditionBytes

public SearchKnowledgeRequest.SearchConfig.BoostSpecs.BoostSpec.ConditionBoostSpec.Builder setConditionBytes(com.google.protobuf.ByteString value)

 Optional. An expression which specifies a boost condition. The
 syntax and supported fields are the same as a filter expression.
 Examples:

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

string condition = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameters:

value - The bytes for condition to set.

Returns:

This builder for chaining.

getBoost

public float getBoost()

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

float boost = 2 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getBoost in interface SearchKnowledgeRequest.SearchConfig.BoostSpecs.BoostSpec.ConditionBoostSpecOrBuilder

Returns:

The boost.

setBoost

public SearchKnowledgeRequest.SearchConfig.BoostSpecs.BoostSpec.ConditionBoostSpec.Builder setBoost(float value)

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

float boost = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameters:

value - The boost to set.

Returns:

This builder for chaining.

clearBoost

public SearchKnowledgeRequest.SearchConfig.BoostSpecs.BoostSpec.ConditionBoostSpec.Builder clearBoost()

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

float boost = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns:

This builder for chaining.

hasBoostControlSpec

public boolean hasBoostControlSpec()

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

.google.cloud.dialogflow.v2.SearchKnowledgeRequest.SearchConfig.BoostSpecs.BoostSpec.ConditionBoostSpec.BoostControlSpec boost_control_spec = 4 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

hasBoostControlSpec in interface SearchKnowledgeRequest.SearchConfig.BoostSpecs.BoostSpec.ConditionBoostSpecOrBuilder

Returns:

Whether the boostControlSpec field is set.

getBoostControlSpec

public SearchKnowledgeRequest.SearchConfig.BoostSpecs.BoostSpec.ConditionBoostSpec.BoostControlSpec getBoostControlSpec()

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

.google.cloud.dialogflow.v2.SearchKnowledgeRequest.SearchConfig.BoostSpecs.BoostSpec.ConditionBoostSpec.BoostControlSpec boost_control_spec = 4 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getBoostControlSpec in interface SearchKnowledgeRequest.SearchConfig.BoostSpecs.BoostSpec.ConditionBoostSpecOrBuilder

Returns:

The boostControlSpec.

setBoostControlSpec

public SearchKnowledgeRequest.SearchConfig.BoostSpecs.BoostSpec.ConditionBoostSpec.Builder setBoostControlSpec(SearchKnowledgeRequest.SearchConfig.BoostSpecs.BoostSpec.ConditionBoostSpec.BoostControlSpec value)

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

.google.cloud.dialogflow.v2.SearchKnowledgeRequest.SearchConfig.BoostSpecs.BoostSpec.ConditionBoostSpec.BoostControlSpec boost_control_spec = 4 [(.google.api.field_behavior) = OPTIONAL];

setBoostControlSpec

public SearchKnowledgeRequest.SearchConfig.BoostSpecs.BoostSpec.ConditionBoostSpec.Builder setBoostControlSpec(SearchKnowledgeRequest.SearchConfig.BoostSpecs.BoostSpec.ConditionBoostSpec.BoostControlSpec.Builder builderForValue)

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

.google.cloud.dialogflow.v2.SearchKnowledgeRequest.SearchConfig.BoostSpecs.BoostSpec.ConditionBoostSpec.BoostControlSpec boost_control_spec = 4 [(.google.api.field_behavior) = OPTIONAL];

mergeBoostControlSpec

public SearchKnowledgeRequest.SearchConfig.BoostSpecs.BoostSpec.ConditionBoostSpec.Builder mergeBoostControlSpec(SearchKnowledgeRequest.SearchConfig.BoostSpecs.BoostSpec.ConditionBoostSpec.BoostControlSpec value)

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

.google.cloud.dialogflow.v2.SearchKnowledgeRequest.SearchConfig.BoostSpecs.BoostSpec.ConditionBoostSpec.BoostControlSpec boost_control_spec = 4 [(.google.api.field_behavior) = OPTIONAL];

clearBoostControlSpec

public SearchKnowledgeRequest.SearchConfig.BoostSpecs.BoostSpec.ConditionBoostSpec.Builder clearBoostControlSpec()

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

.google.cloud.dialogflow.v2.SearchKnowledgeRequest.SearchConfig.BoostSpecs.BoostSpec.ConditionBoostSpec.BoostControlSpec boost_control_spec = 4 [(.google.api.field_behavior) = OPTIONAL];

getBoostControlSpecBuilder

public SearchKnowledgeRequest.SearchConfig.BoostSpecs.BoostSpec.ConditionBoostSpec.BoostControlSpec.Builder getBoostControlSpecBuilder()

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

.google.cloud.dialogflow.v2.SearchKnowledgeRequest.SearchConfig.BoostSpecs.BoostSpec.ConditionBoostSpec.BoostControlSpec boost_control_spec = 4 [(.google.api.field_behavior) = OPTIONAL];

getBoostControlSpecOrBuilder

public SearchKnowledgeRequest.SearchConfig.BoostSpecs.BoostSpec.ConditionBoostSpec.BoostControlSpecOrBuilder getBoostControlSpecOrBuilder()

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

.google.cloud.dialogflow.v2.SearchKnowledgeRequest.SearchConfig.BoostSpecs.BoostSpec.ConditionBoostSpec.BoostControlSpec boost_control_spec = 4 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getBoostControlSpecOrBuilder in interface SearchKnowledgeRequest.SearchConfig.BoostSpecs.BoostSpec.ConditionBoostSpecOrBuilder