public static final class DataStoreTool.BoostSpec.ConditionBoostSpec.Builder extends GeneratedMessage.Builder<DataStoreTool.BoostSpec.ConditionBoostSpec.Builder> implements DataStoreTool.BoostSpec.ConditionBoostSpecOrBuilderBoost specification for a condition.
Protobuf type google.cloud.ces.v1.DataStoreTool.BoostSpec.ConditionBoostSpec
Inheritance
java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > DataStoreTool.BoostSpec.ConditionBoostSpec.BuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
build()
public DataStoreTool.BoostSpec.ConditionBoostSpec build()| Returns | |
|---|---|
| Type | Description |
DataStoreTool.BoostSpec.ConditionBoostSpec |
|
buildPartial()
public DataStoreTool.BoostSpec.ConditionBoostSpec buildPartial()| Returns | |
|---|---|
| Type | Description |
DataStoreTool.BoostSpec.ConditionBoostSpec |
|
clear()
public DataStoreTool.BoostSpec.ConditionBoostSpec.Builder clear()| Returns | |
|---|---|
| Type | Description |
DataStoreTool.BoostSpec.ConditionBoostSpec.Builder |
|
clearBoost()
public DataStoreTool.BoostSpec.ConditionBoostSpec.Builder clearBoost()Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
DataStoreTool.BoostSpec.ConditionBoostSpec.Builder |
This builder for chaining. |
clearBoostControlSpec()
public DataStoreTool.BoostSpec.ConditionBoostSpec.Builder clearBoostControlSpec()Optional. Complex specification for custom ranking based on customer defined attribute value.
.google.cloud.ces.v1.DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec boost_control_spec = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
DataStoreTool.BoostSpec.ConditionBoostSpec.Builder |
|
clearCondition()
public DataStoreTool.BoostSpec.ConditionBoostSpec.Builder clearCondition()Required. An expression which specifies a boost condition. The syntax is the same as 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 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
DataStoreTool.BoostSpec.ConditionBoostSpec.Builder |
This builder for chaining. |
getBoost()
public float getBoost()Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
float |
The boost. |
getBoostControlSpec()
public DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec getBoostControlSpec()Optional. Complex specification for custom ranking based on customer defined attribute value.
.google.cloud.ces.v1.DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec boost_control_spec = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec |
The boostControlSpec. |
getBoostControlSpecBuilder()
public DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec.Builder getBoostControlSpecBuilder()Optional. Complex specification for custom ranking based on customer defined attribute value.
.google.cloud.ces.v1.DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec boost_control_spec = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec.Builder |
|
getBoostControlSpecOrBuilder()
public DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpecOrBuilder getBoostControlSpecOrBuilder()Optional. Complex specification for custom ranking based on customer defined attribute value.
.google.cloud.ces.v1.DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec boost_control_spec = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpecOrBuilder |
|
getCondition()
public String getCondition()Required. An expression which specifies a boost condition. The syntax is the same as 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 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
String |
The condition. |
getConditionBytes()
public ByteString getConditionBytes()Required. An expression which specifies a boost condition. The syntax is the same as 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 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for condition. |
getDefaultInstanceForType()
public DataStoreTool.BoostSpec.ConditionBoostSpec getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
DataStoreTool.BoostSpec.ConditionBoostSpec |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
hasBoostControlSpec()
public boolean hasBoostControlSpec()Optional. Complex specification for custom ranking based on customer defined attribute value.
.google.cloud.ces.v1.DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec boost_control_spec = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the boostControlSpec field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeBoostControlSpec(DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec value)
public DataStoreTool.BoostSpec.ConditionBoostSpec.Builder mergeBoostControlSpec(DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec value)Optional. Complex specification for custom ranking based on customer defined attribute value.
.google.cloud.ces.v1.DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec boost_control_spec = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec |
| Returns | |
|---|---|
| Type | Description |
DataStoreTool.BoostSpec.ConditionBoostSpec.Builder |
|
mergeFrom(DataStoreTool.BoostSpec.ConditionBoostSpec other)
public DataStoreTool.BoostSpec.ConditionBoostSpec.Builder mergeFrom(DataStoreTool.BoostSpec.ConditionBoostSpec other)| Parameter | |
|---|---|
| Name | Description |
other |
DataStoreTool.BoostSpec.ConditionBoostSpec |
| Returns | |
|---|---|
| Type | Description |
DataStoreTool.BoostSpec.ConditionBoostSpec.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public DataStoreTool.BoostSpec.ConditionBoostSpec.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
DataStoreTool.BoostSpec.ConditionBoostSpec.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public DataStoreTool.BoostSpec.ConditionBoostSpec.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
DataStoreTool.BoostSpec.ConditionBoostSpec.Builder |
|
setBoost(float value)
public DataStoreTool.BoostSpec.ConditionBoostSpec.Builder setBoost(float value)Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
floatThe boost to set. |
| Returns | |
|---|---|
| Type | Description |
DataStoreTool.BoostSpec.ConditionBoostSpec.Builder |
This builder for chaining. |
setBoostControlSpec(DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec value)
public DataStoreTool.BoostSpec.ConditionBoostSpec.Builder setBoostControlSpec(DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec value)Optional. Complex specification for custom ranking based on customer defined attribute value.
.google.cloud.ces.v1.DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec boost_control_spec = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec |
| Returns | |
|---|---|
| Type | Description |
DataStoreTool.BoostSpec.ConditionBoostSpec.Builder |
|
setBoostControlSpec(DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec.Builder builderForValue)
public DataStoreTool.BoostSpec.ConditionBoostSpec.Builder setBoostControlSpec(DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec.Builder builderForValue)Optional. Complex specification for custom ranking based on customer defined attribute value.
.google.cloud.ces.v1.DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec boost_control_spec = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec.Builder |
| Returns | |
|---|---|
| Type | Description |
DataStoreTool.BoostSpec.ConditionBoostSpec.Builder |
|
setCondition(String value)
public DataStoreTool.BoostSpec.ConditionBoostSpec.Builder setCondition(String value)Required. An expression which specifies a boost condition. The syntax is the same as 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 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe condition to set. |
| Returns | |
|---|---|
| Type | Description |
DataStoreTool.BoostSpec.ConditionBoostSpec.Builder |
This builder for chaining. |
setConditionBytes(ByteString value)
public DataStoreTool.BoostSpec.ConditionBoostSpec.Builder setConditionBytes(ByteString value)Required. An expression which specifies a boost condition. The syntax is the same as 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 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for condition to set. |
| Returns | |
|---|---|
| Type | Description |
DataStoreTool.BoostSpec.ConditionBoostSpec.Builder |
This builder for chaining. |