com.google.cloud.retail.v2.ServingConfigOrBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of proto-google-cloud-retail-v2 Show documentation
Proto library for google-cloud-retail
The newest version!
/*
 * Copyright 2024 Google LLC
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: google/cloud/retail/v2/serving_config.proto

// Protobuf Java Version: 3.25.5
package com.google.cloud.retail.v2;

public interface ServingConfigOrBuilder
    extends
    // @@protoc_insertion_point(interface_extends:google.cloud.retail.v2.ServingConfig)
    com.google.protobuf.MessageOrBuilder {

  /**
   *
   *
   *    * Immutable. Fully qualified name
   * `projects/*/locations/global/catalogs/*/servingConfig/*`
   * 
   *
   * string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
   *
   * @return The name.
   */
  java.lang.String getName();
  /**
   *
   *
   *    * Immutable. Fully qualified name
   * `projects/*/locations/global/catalogs/*/servingConfig/*`
   * 
   *
   * string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
   *
   * @return The bytes for name.
   */
  com.google.protobuf.ByteString getNameBytes();

  /**
   *
   *
   *    * Required. The human readable serving config display name. Used in Retail
   * UI.
   *
   * This field must be a UTF-8 encoded string with a length limit of 128
   * characters. Otherwise, an INVALID_ARGUMENT error is returned.
   * 
   *
   * string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
   *
   * @return The displayName.
   */
  java.lang.String getDisplayName();
  /**
   *
   *
   *    * Required. The human readable serving config display name. Used in Retail
   * UI.
   *
   * This field must be a UTF-8 encoded string with a length limit of 128
   * characters. Otherwise, an INVALID_ARGUMENT error is returned.
   * 
   *
   * string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
   *
   * @return The bytes for displayName.
   */
  com.google.protobuf.ByteString getDisplayNameBytes();

  /**
   *
   *
   *    * The id of the model in the same [Catalog][google.cloud.retail.v2.Catalog]
   * to use at serving time. Currently only RecommendationModels are supported:
   * https://cloud.google.com/retail/recommendations-ai/docs/create-models
   * Can be changed but only to a compatible model (e.g.
   * others-you-may-like CTR to others-you-may-like CVR).
   *
   * Required when
   * [solution_types][google.cloud.retail.v2.ServingConfig.solution_types] is
   * [SOLUTION_TYPE_RECOMMENDATION][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_RECOMMENDATION].
   * 
   *
   * string model_id = 3;
   *
   * @return The modelId.
   */
  java.lang.String getModelId();
  /**
   *
   *
   *    * The id of the model in the same [Catalog][google.cloud.retail.v2.Catalog]
   * to use at serving time. Currently only RecommendationModels are supported:
   * https://cloud.google.com/retail/recommendations-ai/docs/create-models
   * Can be changed but only to a compatible model (e.g.
   * others-you-may-like CTR to others-you-may-like CVR).
   *
   * Required when
   * [solution_types][google.cloud.retail.v2.ServingConfig.solution_types] is
   * [SOLUTION_TYPE_RECOMMENDATION][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_RECOMMENDATION].
   * 
   *
   * string model_id = 3;
   *
   * @return The bytes for modelId.
   */
  com.google.protobuf.ByteString getModelIdBytes();

  /**
   *
   *
   *    * How much price ranking we want in serving results.
   * Price reranking causes product items with a similar
   * recommendation probability to be ordered by price, with the
   * highest-priced items first. This setting could result in a decrease in
   * click-through and conversion rates.
   *  Allowed values are:
   *
   * * `no-price-reranking`
   * * `low-price-reranking`
   * * `medium-price-reranking`
   * * `high-price-reranking`
   *
   * If not specified, we choose default based on model type. Default value:
   * `no-price-reranking`.
   *
   * Can only be set if
   * [solution_types][google.cloud.retail.v2.ServingConfig.solution_types] is
   * [SOLUTION_TYPE_RECOMMENDATION][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_RECOMMENDATION].
   * 
   *
   * string price_reranking_level = 4;
   *
   * @return The priceRerankingLevel.
   */
  java.lang.String getPriceRerankingLevel();
  /**
   *
   *
   *    * How much price ranking we want in serving results.
   * Price reranking causes product items with a similar
   * recommendation probability to be ordered by price, with the
   * highest-priced items first. This setting could result in a decrease in
   * click-through and conversion rates.
   *  Allowed values are:
   *
   * * `no-price-reranking`
   * * `low-price-reranking`
   * * `medium-price-reranking`
   * * `high-price-reranking`
   *
   * If not specified, we choose default based on model type. Default value:
   * `no-price-reranking`.
   *
   * Can only be set if
   * [solution_types][google.cloud.retail.v2.ServingConfig.solution_types] is
   * [SOLUTION_TYPE_RECOMMENDATION][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_RECOMMENDATION].
   * 
   *
   * string price_reranking_level = 4;
   *
   * @return The bytes for priceRerankingLevel.
   */
  com.google.protobuf.ByteString getPriceRerankingLevelBytes();

  /**
   *
   *
   *    * Facet specifications for faceted search. If empty, no facets are returned.
   * The ids refer to the ids of [Control][google.cloud.retail.v2.Control]
   * resources with only the Facet control set. These controls are assumed to be
   * in the same [Catalog][google.cloud.retail.v2.Catalog] as the
   * [ServingConfig][google.cloud.retail.v2.ServingConfig].
   * A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error
   * is returned.
   *
   * Can only be set if
   * [solution_types][google.cloud.retail.v2.ServingConfig.solution_types] is
   * [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].
   * 
   *
   * repeated string facet_control_ids = 5;
   *
   * @return A list containing the facetControlIds.
   */
  java.util.List getFacetControlIdsList();
  /**
   *
   *
   *    * Facet specifications for faceted search. If empty, no facets are returned.
   * The ids refer to the ids of [Control][google.cloud.retail.v2.Control]
   * resources with only the Facet control set. These controls are assumed to be
   * in the same [Catalog][google.cloud.retail.v2.Catalog] as the
   * [ServingConfig][google.cloud.retail.v2.ServingConfig].
   * A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error
   * is returned.
   *
   * Can only be set if
   * [solution_types][google.cloud.retail.v2.ServingConfig.solution_types] is
   * [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].
   * 
   *
   * repeated string facet_control_ids = 5;
   *
   * @return The count of facetControlIds.
   */
  int getFacetControlIdsCount();
  /**
   *
   *
   *    * Facet specifications for faceted search. If empty, no facets are returned.
   * The ids refer to the ids of [Control][google.cloud.retail.v2.Control]
   * resources with only the Facet control set. These controls are assumed to be
   * in the same [Catalog][google.cloud.retail.v2.Catalog] as the
   * [ServingConfig][google.cloud.retail.v2.ServingConfig].
   * A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error
   * is returned.
   *
   * Can only be set if
   * [solution_types][google.cloud.retail.v2.ServingConfig.solution_types] is
   * [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].
   * 
   *
   * repeated string facet_control_ids = 5;
   *
   * @param index The index of the element to return.
   * @return The facetControlIds at the given index.
   */
  java.lang.String getFacetControlIds(int index);
  /**
   *
   *
   *    * Facet specifications for faceted search. If empty, no facets are returned.
   * The ids refer to the ids of [Control][google.cloud.retail.v2.Control]
   * resources with only the Facet control set. These controls are assumed to be
   * in the same [Catalog][google.cloud.retail.v2.Catalog] as the
   * [ServingConfig][google.cloud.retail.v2.ServingConfig].
   * A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error
   * is returned.
   *
   * Can only be set if
   * [solution_types][google.cloud.retail.v2.ServingConfig.solution_types] is
   * [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].
   * 
   *
   * repeated string facet_control_ids = 5;
   *
   * @param index The index of the value to return.
   * @return The bytes of the facetControlIds at the given index.
   */
  com.google.protobuf.ByteString getFacetControlIdsBytes(int index);

  /**
   *
   *
   *    * The specification for dynamically generated facets. Notice that only
   * textual facets can be dynamically generated.
   *
   * Can only be set if
   * [solution_types][google.cloud.retail.v2.ServingConfig.solution_types] is
   * [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].
   * 
   *
   * .google.cloud.retail.v2.SearchRequest.DynamicFacetSpec dynamic_facet_spec = 6;
   *
   * @return Whether the dynamicFacetSpec field is set.
   */
  boolean hasDynamicFacetSpec();
  /**
   *
   *
   *    * The specification for dynamically generated facets. Notice that only
   * textual facets can be dynamically generated.
   *
   * Can only be set if
   * [solution_types][google.cloud.retail.v2.ServingConfig.solution_types] is
   * [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].
   * 
   *
   * .google.cloud.retail.v2.SearchRequest.DynamicFacetSpec dynamic_facet_spec = 6;
   *
   * @return The dynamicFacetSpec.
   */
  com.google.cloud.retail.v2.SearchRequest.DynamicFacetSpec getDynamicFacetSpec();
  /**
   *
   *
   *    * The specification for dynamically generated facets. Notice that only
   * textual facets can be dynamically generated.
   *
   * Can only be set if
   * [solution_types][google.cloud.retail.v2.ServingConfig.solution_types] is
   * [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].
   * 
   *
   * .google.cloud.retail.v2.SearchRequest.DynamicFacetSpec dynamic_facet_spec = 6;
   */
  com.google.cloud.retail.v2.SearchRequest.DynamicFacetSpecOrBuilder getDynamicFacetSpecOrBuilder();

  /**
   *
   *
   *    * Condition boost specifications. If a product matches multiple conditions
   * in the specifications, boost scores from these specifications are all
   * applied and combined in a non-linear way. Maximum number of
   * specifications is 100.
   *
   * Notice that if both
   * [ServingConfig.boost_control_ids][google.cloud.retail.v2.ServingConfig.boost_control_ids]
   * and
   * [SearchRequest.boost_spec][google.cloud.retail.v2.SearchRequest.boost_spec]
   * are set, the boost conditions from both places are evaluated. If a search
   * request matches multiple boost conditions, the final boost score is equal
   * to the sum of the boost scores from all matched boost conditions.
   *
   * Can only be set if
   * [solution_types][google.cloud.retail.v2.ServingConfig.solution_types] is
   * [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].
   * 
   *
   * repeated string boost_control_ids = 7;
   *
   * @return A list containing the boostControlIds.
   */
  java.util.List getBoostControlIdsList();
  /**
   *
   *
   *    * Condition boost specifications. If a product matches multiple conditions
   * in the specifications, boost scores from these specifications are all
   * applied and combined in a non-linear way. Maximum number of
   * specifications is 100.
   *
   * Notice that if both
   * [ServingConfig.boost_control_ids][google.cloud.retail.v2.ServingConfig.boost_control_ids]
   * and
   * [SearchRequest.boost_spec][google.cloud.retail.v2.SearchRequest.boost_spec]
   * are set, the boost conditions from both places are evaluated. If a search
   * request matches multiple boost conditions, the final boost score is equal
   * to the sum of the boost scores from all matched boost conditions.
   *
   * Can only be set if
   * [solution_types][google.cloud.retail.v2.ServingConfig.solution_types] is
   * [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].
   * 
   *
   * repeated string boost_control_ids = 7;
   *
   * @return The count of boostControlIds.
   */
  int getBoostControlIdsCount();
  /**
   *
   *
   *    * Condition boost specifications. If a product matches multiple conditions
   * in the specifications, boost scores from these specifications are all
   * applied and combined in a non-linear way. Maximum number of
   * specifications is 100.
   *
   * Notice that if both
   * [ServingConfig.boost_control_ids][google.cloud.retail.v2.ServingConfig.boost_control_ids]
   * and
   * [SearchRequest.boost_spec][google.cloud.retail.v2.SearchRequest.boost_spec]
   * are set, the boost conditions from both places are evaluated. If a search
   * request matches multiple boost conditions, the final boost score is equal
   * to the sum of the boost scores from all matched boost conditions.
   *
   * Can only be set if
   * [solution_types][google.cloud.retail.v2.ServingConfig.solution_types] is
   * [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].
   * 
   *
   * repeated string boost_control_ids = 7;
   *
   * @param index The index of the element to return.
   * @return The boostControlIds at the given index.
   */
  java.lang.String getBoostControlIds(int index);
  /**
   *
   *
   *    * Condition boost specifications. If a product matches multiple conditions
   * in the specifications, boost scores from these specifications are all
   * applied and combined in a non-linear way. Maximum number of
   * specifications is 100.
   *
   * Notice that if both
   * [ServingConfig.boost_control_ids][google.cloud.retail.v2.ServingConfig.boost_control_ids]
   * and
   * [SearchRequest.boost_spec][google.cloud.retail.v2.SearchRequest.boost_spec]
   * are set, the boost conditions from both places are evaluated. If a search
   * request matches multiple boost conditions, the final boost score is equal
   * to the sum of the boost scores from all matched boost conditions.
   *
   * Can only be set if
   * [solution_types][google.cloud.retail.v2.ServingConfig.solution_types] is
   * [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].
   * 
   *
   * repeated string boost_control_ids = 7;
   *
   * @param index The index of the value to return.
   * @return The bytes of the boostControlIds at the given index.
   */
  com.google.protobuf.ByteString getBoostControlIdsBytes(int index);

  /**
   *
   *
   *    * Condition filter specifications. If a product matches multiple conditions
   * in the specifications, filters from these specifications are all
   * applied and combined via the AND operator. Maximum number of
   * specifications is 100.
   *
   * Can only be set if
   * [solution_types][google.cloud.retail.v2.ServingConfig.solution_types] is
   * [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].
   * 
   *
   * repeated string filter_control_ids = 9;
   *
   * @return A list containing the filterControlIds.
   */
  java.util.List getFilterControlIdsList();
  /**
   *
   *
   *    * Condition filter specifications. If a product matches multiple conditions
   * in the specifications, filters from these specifications are all
   * applied and combined via the AND operator. Maximum number of
   * specifications is 100.
   *
   * Can only be set if
   * [solution_types][google.cloud.retail.v2.ServingConfig.solution_types] is
   * [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].
   * 
   *
   * repeated string filter_control_ids = 9;
   *
   * @return The count of filterControlIds.
   */
  int getFilterControlIdsCount();
  /**
   *
   *
   *    * Condition filter specifications. If a product matches multiple conditions
   * in the specifications, filters from these specifications are all
   * applied and combined via the AND operator. Maximum number of
   * specifications is 100.
   *
   * Can only be set if
   * [solution_types][google.cloud.retail.v2.ServingConfig.solution_types] is
   * [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].
   * 
   *
   * repeated string filter_control_ids = 9;
   *
   * @param index The index of the element to return.
   * @return The filterControlIds at the given index.
   */
  java.lang.String getFilterControlIds(int index);
  /**
   *
   *
   *    * Condition filter specifications. If a product matches multiple conditions
   * in the specifications, filters from these specifications are all
   * applied and combined via the AND operator. Maximum number of
   * specifications is 100.
   *
   * Can only be set if
   * [solution_types][google.cloud.retail.v2.ServingConfig.solution_types] is
   * [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].
   * 
   *
   * repeated string filter_control_ids = 9;
   *
   * @param index The index of the value to return.
   * @return The bytes of the filterControlIds at the given index.
   */
  com.google.protobuf.ByteString getFilterControlIdsBytes(int index);

  /**
   *
   *
   *    * Condition redirect specifications. Only the first triggered redirect action
   * is applied, even if multiple apply. Maximum number of specifications is
   * 1000.
   *
   * Can only be set if
   * [solution_types][google.cloud.retail.v2.ServingConfig.solution_types] is
   * [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].
   * 
   *
   * repeated string redirect_control_ids = 10;
   *
   * @return A list containing the redirectControlIds.
   */
  java.util.List getRedirectControlIdsList();
  /**
   *
   *
   *    * Condition redirect specifications. Only the first triggered redirect action
   * is applied, even if multiple apply. Maximum number of specifications is
   * 1000.
   *
   * Can only be set if
   * [solution_types][google.cloud.retail.v2.ServingConfig.solution_types] is
   * [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].
   * 
   *
   * repeated string redirect_control_ids = 10;
   *
   * @return The count of redirectControlIds.
   */
  int getRedirectControlIdsCount();
  /**
   *
   *
   *    * Condition redirect specifications. Only the first triggered redirect action
   * is applied, even if multiple apply. Maximum number of specifications is
   * 1000.
   *
   * Can only be set if
   * [solution_types][google.cloud.retail.v2.ServingConfig.solution_types] is
   * [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].
   * 
   *
   * repeated string redirect_control_ids = 10;
   *
   * @param index The index of the element to return.
   * @return The redirectControlIds at the given index.
   */
  java.lang.String getRedirectControlIds(int index);
  /**
   *
   *
   *    * Condition redirect specifications. Only the first triggered redirect action
   * is applied, even if multiple apply. Maximum number of specifications is
   * 1000.
   *
   * Can only be set if
   * [solution_types][google.cloud.retail.v2.ServingConfig.solution_types] is
   * [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].
   * 
   *
   * repeated string redirect_control_ids = 10;
   *
   * @param index The index of the value to return.
   * @return The bytes of the redirectControlIds at the given index.
   */
  com.google.protobuf.ByteString getRedirectControlIdsBytes(int index);

  /**
   *
   *
   *    * Condition synonyms specifications. If multiple syonyms conditions match,
   * all matching synonyms control in the list will execute. Order of controls
   * in the list will not matter. Maximum number of specifications is
   * 100.
   *
   * Can only be set if
   * [solution_types][google.cloud.retail.v2.ServingConfig.solution_types] is
   * [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].
   * 
   *
   * repeated string twoway_synonyms_control_ids = 18;
   *
   * @return A list containing the twowaySynonymsControlIds.
   */
  java.util.List getTwowaySynonymsControlIdsList();
  /**
   *
   *
   *    * Condition synonyms specifications. If multiple syonyms conditions match,
   * all matching synonyms control in the list will execute. Order of controls
   * in the list will not matter. Maximum number of specifications is
   * 100.
   *
   * Can only be set if
   * [solution_types][google.cloud.retail.v2.ServingConfig.solution_types] is
   * [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].
   * 
   *
   * repeated string twoway_synonyms_control_ids = 18;
   *
   * @return The count of twowaySynonymsControlIds.
   */
  int getTwowaySynonymsControlIdsCount();
  /**
   *
   *
   *    * Condition synonyms specifications. If multiple syonyms conditions match,
   * all matching synonyms control in the list will execute. Order of controls
   * in the list will not matter. Maximum number of specifications is
   * 100.
   *
   * Can only be set if
   * [solution_types][google.cloud.retail.v2.ServingConfig.solution_types] is
   * [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].
   * 
   *
   * repeated string twoway_synonyms_control_ids = 18;
   *
   * @param index The index of the element to return.
   * @return The twowaySynonymsControlIds at the given index.
   */
  java.lang.String getTwowaySynonymsControlIds(int index);
  /**
   *
   *
   *    * Condition synonyms specifications. If multiple syonyms conditions match,
   * all matching synonyms control in the list will execute. Order of controls
   * in the list will not matter. Maximum number of specifications is
   * 100.
   *
   * Can only be set if
   * [solution_types][google.cloud.retail.v2.ServingConfig.solution_types] is
   * [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].
   * 
   *
   * repeated string twoway_synonyms_control_ids = 18;
   *
   * @param index The index of the value to return.
   * @return The bytes of the twowaySynonymsControlIds at the given index.
   */
  com.google.protobuf.ByteString getTwowaySynonymsControlIdsBytes(int index);

  /**
   *
   *
   *    * Condition oneway synonyms specifications. If multiple oneway synonyms
   * conditions match, all matching oneway synonyms controls in the list will
   * execute. Order of controls in the list will not matter. Maximum number of
   * specifications is 100.
   *
   * Can only be set if
   * [solution_types][google.cloud.retail.v2.ServingConfig.solution_types] is
   * [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].
   * 
   *
   * repeated string oneway_synonyms_control_ids = 12;
   *
   * @return A list containing the onewaySynonymsControlIds.
   */
  java.util.List getOnewaySynonymsControlIdsList();
  /**
   *
   *
   *    * Condition oneway synonyms specifications. If multiple oneway synonyms
   * conditions match, all matching oneway synonyms controls in the list will
   * execute. Order of controls in the list will not matter. Maximum number of
   * specifications is 100.
   *
   * Can only be set if
   * [solution_types][google.cloud.retail.v2.ServingConfig.solution_types] is
   * [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].
   * 
   *
   * repeated string oneway_synonyms_control_ids = 12;
   *
   * @return The count of onewaySynonymsControlIds.
   */
  int getOnewaySynonymsControlIdsCount();
  /**
   *
   *
   *    * Condition oneway synonyms specifications. If multiple oneway synonyms
   * conditions match, all matching oneway synonyms controls in the list will
   * execute. Order of controls in the list will not matter. Maximum number of
   * specifications is 100.
   *
   * Can only be set if
   * [solution_types][google.cloud.retail.v2.ServingConfig.solution_types] is
   * [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].
   * 
   *
   * repeated string oneway_synonyms_control_ids = 12;
   *
   * @param index The index of the element to return.
   * @return The onewaySynonymsControlIds at the given index.
   */
  java.lang.String getOnewaySynonymsControlIds(int index);
  /**
   *
   *
   *    * Condition oneway synonyms specifications. If multiple oneway synonyms
   * conditions match, all matching oneway synonyms controls in the list will
   * execute. Order of controls in the list will not matter. Maximum number of
   * specifications is 100.
   *
   * Can only be set if
   * [solution_types][google.cloud.retail.v2.ServingConfig.solution_types] is
   * [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].
   * 
   *
   * repeated string oneway_synonyms_control_ids = 12;
   *
   * @param index The index of the value to return.
   * @return The bytes of the onewaySynonymsControlIds at the given index.
   */
  com.google.protobuf.ByteString getOnewaySynonymsControlIdsBytes(int index);

  /**
   *
   *
   *    * Condition do not associate specifications. If multiple do not associate
   * conditions match, all matching do not associate controls in the list will
   * execute.
   * - Order does not matter.
   * - Maximum number of specifications is 100.
   *
   * Can only be set if
   * [solution_types][google.cloud.retail.v2.ServingConfig.solution_types] is
   * [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].
   * 
   *
   * repeated string do_not_associate_control_ids = 13;
   *
   * @return A list containing the doNotAssociateControlIds.
   */
  java.util.List getDoNotAssociateControlIdsList();
  /**
   *
   *
   *    * Condition do not associate specifications. If multiple do not associate
   * conditions match, all matching do not associate controls in the list will
   * execute.
   * - Order does not matter.
   * - Maximum number of specifications is 100.
   *
   * Can only be set if
   * [solution_types][google.cloud.retail.v2.ServingConfig.solution_types] is
   * [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].
   * 
   *
   * repeated string do_not_associate_control_ids = 13;
   *
   * @return The count of doNotAssociateControlIds.
   */
  int getDoNotAssociateControlIdsCount();
  /**
   *
   *
   *    * Condition do not associate specifications. If multiple do not associate
   * conditions match, all matching do not associate controls in the list will
   * execute.
   * - Order does not matter.
   * - Maximum number of specifications is 100.
   *
   * Can only be set if
   * [solution_types][google.cloud.retail.v2.ServingConfig.solution_types] is
   * [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].
   * 
   *
   * repeated string do_not_associate_control_ids = 13;
   *
   * @param index The index of the element to return.
   * @return The doNotAssociateControlIds at the given index.
   */
  java.lang.String getDoNotAssociateControlIds(int index);
  /**
   *
   *
   *    * Condition do not associate specifications. If multiple do not associate
   * conditions match, all matching do not associate controls in the list will
   * execute.
   * - Order does not matter.
   * - Maximum number of specifications is 100.
   *
   * Can only be set if
   * [solution_types][google.cloud.retail.v2.ServingConfig.solution_types] is
   * [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].
   * 
   *
   * repeated string do_not_associate_control_ids = 13;
   *
   * @param index The index of the value to return.
   * @return The bytes of the doNotAssociateControlIds at the given index.
   */
  com.google.protobuf.ByteString getDoNotAssociateControlIdsBytes(int index);

  /**
   *
   *
   *    * Condition replacement specifications.
   * - Applied according to the order in the list.
   * - A previously replaced term can not be re-replaced.
   * - Maximum number of specifications is 100.
   *
   * Can only be set if
   * [solution_types][google.cloud.retail.v2.ServingConfig.solution_types] is
   * [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].
   * 
   *
   * repeated string replacement_control_ids = 14;
   *
   * @return A list containing the replacementControlIds.
   */
  java.util.List getReplacementControlIdsList();
  /**
   *
   *
   *    * Condition replacement specifications.
   * - Applied according to the order in the list.
   * - A previously replaced term can not be re-replaced.
   * - Maximum number of specifications is 100.
   *
   * Can only be set if
   * [solution_types][google.cloud.retail.v2.ServingConfig.solution_types] is
   * [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].
   * 
   *
   * repeated string replacement_control_ids = 14;
   *
   * @return The count of replacementControlIds.
   */
  int getReplacementControlIdsCount();
  /**
   *
   *
   *    * Condition replacement specifications.
   * - Applied according to the order in the list.
   * - A previously replaced term can not be re-replaced.
   * - Maximum number of specifications is 100.
   *
   * Can only be set if
   * [solution_types][google.cloud.retail.v2.ServingConfig.solution_types] is
   * [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].
   * 
   *
   * repeated string replacement_control_ids = 14;
   *
   * @param index The index of the element to return.
   * @return The replacementControlIds at the given index.
   */
  java.lang.String getReplacementControlIds(int index);
  /**
   *
   *
   *    * Condition replacement specifications.
   * - Applied according to the order in the list.
   * - A previously replaced term can not be re-replaced.
   * - Maximum number of specifications is 100.
   *
   * Can only be set if
   * [solution_types][google.cloud.retail.v2.ServingConfig.solution_types] is
   * [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].
   * 
   *
   * repeated string replacement_control_ids = 14;
   *
   * @param index The index of the value to return.
   * @return The bytes of the replacementControlIds at the given index.
   */
  com.google.protobuf.ByteString getReplacementControlIdsBytes(int index);

  /**
   *
   *
   *    * Condition ignore specifications. If multiple ignore
   * conditions match, all matching ignore controls in the list will
   * execute.
   * - Order does not matter.
   * - Maximum number of specifications is 100.
   *
   * Can only be set if
   * [solution_types][google.cloud.retail.v2.ServingConfig.solution_types] is
   * [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].
   * 
   *
   * repeated string ignore_control_ids = 15;
   *
   * @return A list containing the ignoreControlIds.
   */
  java.util.List getIgnoreControlIdsList();
  /**
   *
   *
   *    * Condition ignore specifications. If multiple ignore
   * conditions match, all matching ignore controls in the list will
   * execute.
   * - Order does not matter.
   * - Maximum number of specifications is 100.
   *
   * Can only be set if
   * [solution_types][google.cloud.retail.v2.ServingConfig.solution_types] is
   * [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].
   * 
   *
   * repeated string ignore_control_ids = 15;
   *
   * @return The count of ignoreControlIds.
   */
  int getIgnoreControlIdsCount();
  /**
   *
   *
   *    * Condition ignore specifications. If multiple ignore
   * conditions match, all matching ignore controls in the list will
   * execute.
   * - Order does not matter.
   * - Maximum number of specifications is 100.
   *
   * Can only be set if
   * [solution_types][google.cloud.retail.v2.ServingConfig.solution_types] is
   * [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].
   * 
   *
   * repeated string ignore_control_ids = 15;
   *
   * @param index The index of the element to return.
   * @return The ignoreControlIds at the given index.
   */
  java.lang.String getIgnoreControlIds(int index);
  /**
   *
   *
   *    * Condition ignore specifications. If multiple ignore
   * conditions match, all matching ignore controls in the list will
   * execute.
   * - Order does not matter.
   * - Maximum number of specifications is 100.
   *
   * Can only be set if
   * [solution_types][google.cloud.retail.v2.ServingConfig.solution_types] is
   * [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].
   * 
   *
   * repeated string ignore_control_ids = 15;
   *
   * @param index The index of the value to return.
   * @return The bytes of the ignoreControlIds at the given index.
   */
  com.google.protobuf.ByteString getIgnoreControlIdsBytes(int index);

  /**
   *
   *
   *    * How much diversity to use in recommendation model results e.g.
   * `medium-diversity` or `high-diversity`. Currently supported values:
   *
   * * `no-diversity`
   * * `low-diversity`
   * * `medium-diversity`
   * * `high-diversity`
   * * `auto-diversity`
   *
   * If not specified, we choose default based on recommendation model
   * type. Default value: `no-diversity`.
   *
   * Can only be set if
   * [solution_types][google.cloud.retail.v2.ServingConfig.solution_types] is
   * [SOLUTION_TYPE_RECOMMENDATION][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_RECOMMENDATION].
   * 
   *
   * string diversity_level = 8;
   *
   * @return The diversityLevel.
   */
  java.lang.String getDiversityLevel();
  /**
   *
   *
   *    * How much diversity to use in recommendation model results e.g.
   * `medium-diversity` or `high-diversity`. Currently supported values:
   *
   * * `no-diversity`
   * * `low-diversity`
   * * `medium-diversity`
   * * `high-diversity`
   * * `auto-diversity`
   *
   * If not specified, we choose default based on recommendation model
   * type. Default value: `no-diversity`.
   *
   * Can only be set if
   * [solution_types][google.cloud.retail.v2.ServingConfig.solution_types] is
   * [SOLUTION_TYPE_RECOMMENDATION][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_RECOMMENDATION].
   * 
   *
   * string diversity_level = 8;
   *
   * @return The bytes for diversityLevel.
   */
  com.google.protobuf.ByteString getDiversityLevelBytes();

  /**
   *
   *
   *    * What kind of diversity to use - data driven or rule based. If unset, the
   * server behavior defaults to
   * [RULE_BASED_DIVERSITY][google.cloud.retail.v2.ServingConfig.DiversityType.RULE_BASED_DIVERSITY].
   * 
   *
   * .google.cloud.retail.v2.ServingConfig.DiversityType diversity_type = 20;
   *
   * @return The enum numeric value on the wire for diversityType.
   */
  int getDiversityTypeValue();
  /**
   *
   *
   *    * What kind of diversity to use - data driven or rule based. If unset, the
   * server behavior defaults to
   * [RULE_BASED_DIVERSITY][google.cloud.retail.v2.ServingConfig.DiversityType.RULE_BASED_DIVERSITY].
   * 
   *
   * .google.cloud.retail.v2.ServingConfig.DiversityType diversity_type = 20;
   *
   * @return The diversityType.
   */
  com.google.cloud.retail.v2.ServingConfig.DiversityType getDiversityType();

  /**
   *
   *
   *    * Whether to add additional category filters on the `similar-items` model.
   * If not specified, we enable it by default.
   *  Allowed values are:
   *
   * * `no-category-match`: No additional filtering of original results from
   *   the model and the customer's filters.
   * * `relaxed-category-match`: Only keep results with categories that match
   *   at least one item categories in the PredictRequests's context item.
   *   * If customer also sends filters in the PredictRequest, then the results
   *   will satisfy both conditions (user given and category match).
   *
   * Can only be set if
   * [solution_types][google.cloud.retail.v2.ServingConfig.solution_types] is
   * [SOLUTION_TYPE_RECOMMENDATION][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_RECOMMENDATION].
   * 
   *
   * string enable_category_filter_level = 16;
   *
   * @return The enableCategoryFilterLevel.
   */
  java.lang.String getEnableCategoryFilterLevel();
  /**
   *
   *
   *    * Whether to add additional category filters on the `similar-items` model.
   * If not specified, we enable it by default.
   *  Allowed values are:
   *
   * * `no-category-match`: No additional filtering of original results from
   *   the model and the customer's filters.
   * * `relaxed-category-match`: Only keep results with categories that match
   *   at least one item categories in the PredictRequests's context item.
   *   * If customer also sends filters in the PredictRequest, then the results
   *   will satisfy both conditions (user given and category match).
   *
   * Can only be set if
   * [solution_types][google.cloud.retail.v2.ServingConfig.solution_types] is
   * [SOLUTION_TYPE_RECOMMENDATION][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_RECOMMENDATION].
   * 
   *
   * string enable_category_filter_level = 16;
   *
   * @return The bytes for enableCategoryFilterLevel.
   */
  com.google.protobuf.ByteString getEnableCategoryFilterLevelBytes();

  /**
   *
   *
   *    * When the flag is enabled, the products in the denylist will not be filtered
   * out in the recommendation filtering results.
   * 
   *
   * bool ignore_recs_denylist = 24;
   *
   * @return The ignoreRecsDenylist.
   */
  boolean getIgnoreRecsDenylist();

  /**
   *
   *
   *    * The specification for personalization spec.
   *
   * Can only be set if
   * [solution_types][google.cloud.retail.v2.ServingConfig.solution_types] is
   * [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].
   *
   * Notice that if both
   * [ServingConfig.personalization_spec][google.cloud.retail.v2.ServingConfig.personalization_spec]
   * and
   * [SearchRequest.personalization_spec][google.cloud.retail.v2.SearchRequest.personalization_spec]
   * are set.
   * [SearchRequest.personalization_spec][google.cloud.retail.v2.SearchRequest.personalization_spec]
   * will override
   * [ServingConfig.personalization_spec][google.cloud.retail.v2.ServingConfig.personalization_spec].
   * 
   *
   * .google.cloud.retail.v2.SearchRequest.PersonalizationSpec personalization_spec = 21;
   * 
   *
   * @return Whether the personalizationSpec field is set.
   */
  boolean hasPersonalizationSpec();
  /**
   *
   *
   *    * The specification for personalization spec.
   *
   * Can only be set if
   * [solution_types][google.cloud.retail.v2.ServingConfig.solution_types] is
   * [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].
   *
   * Notice that if both
   * [ServingConfig.personalization_spec][google.cloud.retail.v2.ServingConfig.personalization_spec]
   * and
   * [SearchRequest.personalization_spec][google.cloud.retail.v2.SearchRequest.personalization_spec]
   * are set.
   * [SearchRequest.personalization_spec][google.cloud.retail.v2.SearchRequest.personalization_spec]
   * will override
   * [ServingConfig.personalization_spec][google.cloud.retail.v2.ServingConfig.personalization_spec].
   * 
   *
   * .google.cloud.retail.v2.SearchRequest.PersonalizationSpec personalization_spec = 21;
   * 
   *
   * @return The personalizationSpec.
   */
  com.google.cloud.retail.v2.SearchRequest.PersonalizationSpec getPersonalizationSpec();
  /**
   *
   *
   *    * The specification for personalization spec.
   *
   * Can only be set if
   * [solution_types][google.cloud.retail.v2.ServingConfig.solution_types] is
   * [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].
   *
   * Notice that if both
   * [ServingConfig.personalization_spec][google.cloud.retail.v2.ServingConfig.personalization_spec]
   * and
   * [SearchRequest.personalization_spec][google.cloud.retail.v2.SearchRequest.personalization_spec]
   * are set.
   * [SearchRequest.personalization_spec][google.cloud.retail.v2.SearchRequest.personalization_spec]
   * will override
   * [ServingConfig.personalization_spec][google.cloud.retail.v2.ServingConfig.personalization_spec].
   * 
   *
   * .google.cloud.retail.v2.SearchRequest.PersonalizationSpec personalization_spec = 21;
   * 
   */
  com.google.cloud.retail.v2.SearchRequest.PersonalizationSpecOrBuilder
      getPersonalizationSpecOrBuilder();

  /**
   *
   *
   *    * Required. Immutable. Specifies the solution types that a serving config can
   * be associated with. Currently we support setting only one type of solution.
   * 
   *
   * 
   * repeated .google.cloud.retail.v2.SolutionType solution_types = 19 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
   * 
   *
   * @return A list containing the solutionTypes.
   */
  java.util.List getSolutionTypesList();
  /**
   *
   *
   *    * Required. Immutable. Specifies the solution types that a serving config can
   * be associated with. Currently we support setting only one type of solution.
   * 
   *
   * 
   * repeated .google.cloud.retail.v2.SolutionType solution_types = 19 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
   * 
   *
   * @return The count of solutionTypes.
   */
  int getSolutionTypesCount();
  /**
   *
   *
   *    * Required. Immutable. Specifies the solution types that a serving config can
   * be associated with. Currently we support setting only one type of solution.
   * 
   *
   * 
   * repeated .google.cloud.retail.v2.SolutionType solution_types = 19 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
   * 
   *
   * @param index The index of the element to return.
   * @return The solutionTypes at the given index.
   */
  com.google.cloud.retail.v2.SolutionType getSolutionTypes(int index);
  /**
   *
   *
   *    * Required. Immutable. Specifies the solution types that a serving config can
   * be associated with. Currently we support setting only one type of solution.
   * 
   *
   * 
   * repeated .google.cloud.retail.v2.SolutionType solution_types = 19 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
   * 
   *
   * @return A list containing the enum numeric values on the wire for solutionTypes.
   */
  java.util.List getSolutionTypesValueList();
  /**
   *
   *
   *    * Required. Immutable. Specifies the solution types that a serving config can
   * be associated with. Currently we support setting only one type of solution.
   * 
   *
   * 
   * repeated .google.cloud.retail.v2.SolutionType solution_types = 19 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
   * 
   *
   * @param index The index of the value to return.
   * @return The enum numeric value on the wire of solutionTypes at the given index.
   */
  int getSolutionTypesValue(int index);
}