# Interface BoostSpec.ConditionBoostSpecOrBuilder (0.104.0)

0.104.0 (latest) 0.102.0 0.99.0 0.98.0 0.96.0 0.94.0 0.93.0 0.92.0 0.91.0 0.89.0 0.87.0 0.86.0 0.85.0 0.84.0 0.83.0 0.81.0 0.79.0 0.78.0 0.75.0 0.74.0 0.73.0 0.71.0 0.70.0 0.69.0 0.68.0 0.67.0 0.66.0 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 interface BoostSpec.ConditionBoostSpecOrBuilder extends MessageOrBuilder

## Implements

[MessageOrBuilder](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.MessageOrBuilder.html)

## Methods

### getBoost()

    public abstract 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** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | The boost. |

### getBoostControlSpec()

    public abstract BoostSpec.ConditionBoostSpec.BoostControlSpec getBoostControlSpec()

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

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

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-dialogflow-cx/latest/com.google.cloud.dialogflow.cx.v3beta1.BoostSpec.ConditionBoostSpec.BoostControlSpec` | The boostControlSpec. |

### getBoostControlSpecOrBuilder()

    public abstract BoostSpec.ConditionBoostSpec.BoostControlSpecOrBuilder getBoostControlSpecOrBuilder()

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

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

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-dialogflow-cx/latest/com.google.cloud.dialogflow.cx.v3beta1.BoostSpec.ConditionBoostSpec.BoostControlSpecOrBuilder` |   |

### getCondition()

    public abstract 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** |
| `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` | The condition. |

### getConditionBytes()

    public abstract 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** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.ByteString.html` | The bytes for condition. |

### hasBoostControlSpec()

    public abstract boolean hasBoostControlSpec()

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

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

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | Whether the boostControlSpec field is set. |