Class BoostSpec.ConditionBoostSpec.Builder (0.65.0)

Version 0.65.0

• 0.66.0 (latest)
• 0.65.0
• 0.64.0
• 0.63.0
• 0.62.0
• 0.60.0
• 0.59.0
• 0.58.0
• 0.57.0
• 0.56.0
• 0.55.0
• 0.54.0
• 0.53.0
• 0.52.0
• 0.51.0
• 0.50.0
• 0.48.0
• 0.47.0
• 0.46.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.38.0
• 0.35.0
• 0.34.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.7
• 0.13.1
• 0.12.1
• 0.11.5

public static final class BoostSpec.ConditionBoostSpec.Builder extends GeneratedMessageV3.Builder<BoostSpec.ConditionBoostSpec.Builder> implements BoostSpec.ConditionBoostSpecOrBuilder

Boost applies to documents which match a condition.

Protobuf type google.cloud.dialogflow.cx.v3.BoostSpec.ConditionBoostSpec

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > BoostSpec.ConditionBoostSpec.Builder

Implements

BoostSpec.ConditionBoostSpecOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public BoostSpec.ConditionBoostSpec.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
BoostSpec.ConditionBoostSpec.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public BoostSpec.ConditionBoostSpec build()

Returns
Type	Description
BoostSpec.ConditionBoostSpec

buildPartial()

public BoostSpec.ConditionBoostSpec buildPartial()

Returns
Type	Description
BoostSpec.ConditionBoostSpec

clear()

public BoostSpec.ConditionBoostSpec.Builder clear()

Returns
Type	Description
BoostSpec.ConditionBoostSpec.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearBoost()

public 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
Type	Description
BoostSpec.ConditionBoostSpec.Builder	This builder for chaining.

clearBoostControlSpec()

public BoostSpec.ConditionBoostSpec.Builder clearBoostControlSpec()

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

.google.cloud.dialogflow.cx.v3.BoostSpec.ConditionBoostSpec.BoostControlSpec boost_control_spec = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
BoostSpec.ConditionBoostSpec.Builder

clearCondition()

public 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
Type	Description
BoostSpec.ConditionBoostSpec.Builder	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public BoostSpec.ConditionBoostSpec.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
BoostSpec.ConditionBoostSpec.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearOneof(Descriptors.OneofDescriptor oneof)

public BoostSpec.ConditionBoostSpec.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
BoostSpec.ConditionBoostSpec.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clone()

public BoostSpec.ConditionBoostSpec.Builder clone()

Returns
Type	Description
BoostSpec.ConditionBoostSpec.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

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];

Returns
Type	Description
float	The boost.

getBoostControlSpec()

public BoostSpec.ConditionBoostSpec.BoostControlSpec getBoostControlSpec()

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

.google.cloud.dialogflow.cx.v3.BoostSpec.ConditionBoostSpec.BoostControlSpec boost_control_spec = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
BoostSpec.ConditionBoostSpec.BoostControlSpec	The boostControlSpec.

getBoostControlSpecBuilder()

public BoostSpec.ConditionBoostSpec.BoostControlSpec.Builder getBoostControlSpecBuilder()

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

.google.cloud.dialogflow.cx.v3.BoostSpec.ConditionBoostSpec.BoostControlSpec boost_control_spec = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
BoostSpec.ConditionBoostSpec.BoostControlSpec.Builder

getBoostControlSpecOrBuilder()

public BoostSpec.ConditionBoostSpec.BoostControlSpecOrBuilder getBoostControlSpecOrBuilder()

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

.google.cloud.dialogflow.cx.v3.BoostSpec.ConditionBoostSpec.BoostControlSpec boost_control_spec = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
BoostSpec.ConditionBoostSpec.BoostControlSpecOrBuilder

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];

Returns
Type	Description
String	The condition.

getConditionBytes()

public 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];

Returns
Type	Description
ByteString	The bytes for condition.

getDefaultInstanceForType()

public BoostSpec.ConditionBoostSpec getDefaultInstanceForType()

Returns
Type	Description
BoostSpec.ConditionBoostSpec

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

hasBoostControlSpec()

public boolean hasBoostControlSpec()

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

.google.cloud.dialogflow.cx.v3.BoostSpec.ConditionBoostSpec.BoostControlSpec boost_control_spec = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the boostControlSpec field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeBoostControlSpec(BoostSpec.ConditionBoostSpec.BoostControlSpec value)

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

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

.google.cloud.dialogflow.cx.v3.BoostSpec.ConditionBoostSpec.BoostControlSpec boost_control_spec = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	BoostSpec.ConditionBoostSpec.BoostControlSpec

Returns
Type	Description
BoostSpec.ConditionBoostSpec.Builder

mergeFrom(BoostSpec.ConditionBoostSpec other)

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

Parameter
Name	Description
other	BoostSpec.ConditionBoostSpec

Returns
Type	Description
BoostSpec.ConditionBoostSpec.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public BoostSpec.ConditionBoostSpec.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
BoostSpec.ConditionBoostSpec.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public BoostSpec.ConditionBoostSpec.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
BoostSpec.ConditionBoostSpec.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final BoostSpec.ConditionBoostSpec.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
BoostSpec.ConditionBoostSpec.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

setBoost(float value)

public 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];

Parameter
Name	Description
value	float The boost to set.

Returns
Type	Description
BoostSpec.ConditionBoostSpec.Builder	This builder for chaining.

setBoostControlSpec(BoostSpec.ConditionBoostSpec.BoostControlSpec value)

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

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

.google.cloud.dialogflow.cx.v3.BoostSpec.ConditionBoostSpec.BoostControlSpec boost_control_spec = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	BoostSpec.ConditionBoostSpec.BoostControlSpec

Returns
Type	Description
BoostSpec.ConditionBoostSpec.Builder

setBoostControlSpec(BoostSpec.ConditionBoostSpec.BoostControlSpec.Builder builderForValue)

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

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

.google.cloud.dialogflow.cx.v3.BoostSpec.ConditionBoostSpec.BoostControlSpec boost_control_spec = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
builderForValue	BoostSpec.ConditionBoostSpec.BoostControlSpec.Builder

Returns
Type	Description
BoostSpec.ConditionBoostSpec.Builder

setCondition(String value)

public 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];

Parameter
Name	Description
value	String The condition to set.

Returns
Type	Description
BoostSpec.ConditionBoostSpec.Builder	This builder for chaining.

setConditionBytes(ByteString value)

public BoostSpec.ConditionBoostSpec.Builder setConditionBytes(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];

Parameter
Name	Description
value	ByteString The bytes for condition to set.

Returns
Type	Description
BoostSpec.ConditionBoostSpec.Builder	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public BoostSpec.ConditionBoostSpec.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
BoostSpec.ConditionBoostSpec.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

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

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
BoostSpec.ConditionBoostSpec.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setUnknownFields(UnknownFieldSet unknownFields)

public final BoostSpec.ConditionBoostSpec.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
BoostSpec.ConditionBoostSpec.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)