Package com.google.cloud.discoveryengine.v1

Interface Control.BoostActionOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Control.BoostAction, Control.BoostAction.Builder
Enclosing class:
Control
public static interface Control.BoostActionOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • hasFixedBoost

      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:
      Whether the fixedBoost field is set.

    • getFixedBoost

      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:
      The fixedBoost.

    • hasInterpolationBoostSpec

      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:
      Whether the interpolationBoostSpec field is set.

    • getInterpolationBoostSpec

      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:
      The interpolationBoostSpec.

    • getInterpolationBoostSpecOrBuilder

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

    • getBoost

      @Deprecated 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:
      The boost.

    • getFilter

      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:
      The filter.

    • getFilterBytes

      com.google.protobuf.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:
      The bytes for filter.

    • getDataStore

      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:
      The dataStore.

    • getDataStoreBytes

      com.google.protobuf.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:
      The bytes for dataStore.

    • getBoostSpecCase

      Control.BoostAction.BoostSpecCase getBoostSpecCase()