public static interface Control.BoostActionOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getBoost() (deprecated)
public abstract float getBoost()Deprecated. google.cloud.discoveryengine.v1.Control.BoostAction.boost is deprecated. See google/cloud/discoveryengine/v1/control.proto;l=187
Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).
float boost = 1 [deprecated = true];
| Returns | |
|---|---|
| Type | Description |
float |
The boost. |
getBoostSpecCase()
public abstract Control.BoostAction.BoostSpecCase getBoostSpecCase()| Returns | |
|---|---|
| Type | Description |
Control.BoostAction.BoostSpecCase |
|
getDataStore()
public abstract String getDataStore()Required. Specifies which data store's documents can be boosted by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store
string data_store = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
String |
The dataStore. |
getDataStoreBytes()
public abstract ByteString getDataStoreBytes()Required. Specifies which data store's documents can be boosted by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store
string data_store = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for dataStore. |
getFilter()
public abstract String getFilter()Required. Specifies which products to apply the boost to.
If no filter is provided all products will be boosted (No-op). Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown.
string filter = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
String |
The filter. |
getFilterBytes()
public abstract ByteString getFilterBytes()Required. Specifies which products to apply the boost to.
If no filter is provided all products will be boosted (No-op). Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown.
string filter = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for filter. |
getFixedBoost()
public abstract float getFixedBoost()Optional. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).
float fixed_boost = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
float |
The fixedBoost. |
getInterpolationBoostSpec()
public abstract Control.BoostAction.InterpolationBoostSpec getInterpolationBoostSpec()Optional. Complex specification for custom ranking based on customer defined attribute value.
.google.cloud.discoveryengine.v1.Control.BoostAction.InterpolationBoostSpec interpolation_boost_spec = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Control.BoostAction.InterpolationBoostSpec |
The interpolationBoostSpec. |
getInterpolationBoostSpecOrBuilder()
public abstract Control.BoostAction.InterpolationBoostSpecOrBuilder getInterpolationBoostSpecOrBuilder()Optional. Complex specification for custom ranking based on customer defined attribute value.
.google.cloud.discoveryengine.v1.Control.BoostAction.InterpolationBoostSpec interpolation_boost_spec = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Control.BoostAction.InterpolationBoostSpecOrBuilder |
|
hasFixedBoost()
public abstract boolean hasFixedBoost()Optional. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).
float fixed_boost = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the fixedBoost field is set. |
hasInterpolationBoostSpec()
public abstract boolean hasInterpolationBoostSpec()Optional. Complex specification for custom ranking based on customer defined attribute value.
.google.cloud.discoveryengine.v1.Control.BoostAction.InterpolationBoostSpec interpolation_boost_spec = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the interpolationBoostSpec field is set. |