com.google.cloud.retail.v2.ControlOrBuilder 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/control.proto

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

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

  /**
   *
   *
   *    * A rule control - a condition-action pair.
   * Enacts a set action when the condition is triggered.
   * For example: Boost "gShoe" when query full matches "Running Shoes".
   * 
   *
   * .google.cloud.retail.v2.Rule rule = 4;
   *
   * @return Whether the rule field is set.
   */
  boolean hasRule();
  /**
   *
   *
   *    * A rule control - a condition-action pair.
   * Enacts a set action when the condition is triggered.
   * For example: Boost "gShoe" when query full matches "Running Shoes".
   * 
   *
   * .google.cloud.retail.v2.Rule rule = 4;
   *
   * @return The rule.
   */
  com.google.cloud.retail.v2.Rule getRule();
  /**
   *
   *
   *    * A rule control - a condition-action pair.
   * Enacts a set action when the condition is triggered.
   * For example: Boost "gShoe" when query full matches "Running Shoes".
   * 
   *
   * .google.cloud.retail.v2.Rule rule = 4;
   */
  com.google.cloud.retail.v2.RuleOrBuilder getRuleOrBuilder();

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

  /**
   *
   *
   *    * Required. The human readable control 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 thrown.
   * 
   *
   * string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
   *
   * @return The displayName.
   */
  java.lang.String getDisplayName();
  /**
   *
   *
   *    * Required. The human readable control 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 thrown.
   * 
   *
   * string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
   *
   * @return The bytes for displayName.
   */
  com.google.protobuf.ByteString getDisplayNameBytes();

  /**
   *
   *
   *    * Output only. List of [serving config][google.cloud.retail.v2.ServingConfig]
   * ids that are associated with this control in the same
   * [Catalog][google.cloud.retail.v2.Catalog].
   *
   * Note the association is managed via the
   * [ServingConfig][google.cloud.retail.v2.ServingConfig], this is an output
   * only denormalized view.
   * 
   *
   * 
   * repeated string associated_serving_config_ids = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * 
   *
   * @return A list containing the associatedServingConfigIds.
   */
  java.util.List getAssociatedServingConfigIdsList();
  /**
   *
   *
   *    * Output only. List of [serving config][google.cloud.retail.v2.ServingConfig]
   * ids that are associated with this control in the same
   * [Catalog][google.cloud.retail.v2.Catalog].
   *
   * Note the association is managed via the
   * [ServingConfig][google.cloud.retail.v2.ServingConfig], this is an output
   * only denormalized view.
   * 
   *
   * 
   * repeated string associated_serving_config_ids = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * 
   *
   * @return The count of associatedServingConfigIds.
   */
  int getAssociatedServingConfigIdsCount();
  /**
   *
   *
   *    * Output only. List of [serving config][google.cloud.retail.v2.ServingConfig]
   * ids that are associated with this control in the same
   * [Catalog][google.cloud.retail.v2.Catalog].
   *
   * Note the association is managed via the
   * [ServingConfig][google.cloud.retail.v2.ServingConfig], this is an output
   * only denormalized view.
   * 
   *
   * 
   * repeated string associated_serving_config_ids = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * 
   *
   * @param index The index of the element to return.
   * @return The associatedServingConfigIds at the given index.
   */
  java.lang.String getAssociatedServingConfigIds(int index);
  /**
   *
   *
   *    * Output only. List of [serving config][google.cloud.retail.v2.ServingConfig]
   * ids that are associated with this control in the same
   * [Catalog][google.cloud.retail.v2.Catalog].
   *
   * Note the association is managed via the
   * [ServingConfig][google.cloud.retail.v2.ServingConfig], this is an output
   * only denormalized view.
   * 
   *
   * 
   * repeated string associated_serving_config_ids = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * 
   *
   * @param index The index of the value to return.
   * @return The bytes of the associatedServingConfigIds at the given index.
   */
  com.google.protobuf.ByteString getAssociatedServingConfigIdsBytes(int index);

  /**
   *
   *
   *    * Required. Immutable. The solution types that the control is used for.
   * Currently we support setting only one type of solution at creation time.
   *
   * Only `SOLUTION_TYPE_SEARCH` value is supported at the moment.
   * If no solution type is provided at creation time, will default to
   * [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2.SolutionType.SOLUTION_TYPE_SEARCH].
   * 
   *
   * 
   * repeated .google.cloud.retail.v2.SolutionType solution_types = 6 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
   * 
   *
   * @return A list containing the solutionTypes.
   */
  java.util.List getSolutionTypesList();
  /**
   *
   *
   *    * Required. Immutable. The solution types that the control is used for.
   * Currently we support setting only one type of solution at creation time.
   *
   * Only `SOLUTION_TYPE_SEARCH` value is supported at the moment.
   * If no solution type is provided at creation time, will default to
   * [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2.SolutionType.SOLUTION_TYPE_SEARCH].
   * 
   *
   * 
   * repeated .google.cloud.retail.v2.SolutionType solution_types = 6 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
   * 
   *
   * @return The count of solutionTypes.
   */
  int getSolutionTypesCount();
  /**
   *
   *
   *    * Required. Immutable. The solution types that the control is used for.
   * Currently we support setting only one type of solution at creation time.
   *
   * Only `SOLUTION_TYPE_SEARCH` value is supported at the moment.
   * If no solution type is provided at creation time, will default to
   * [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2.SolutionType.SOLUTION_TYPE_SEARCH].
   * 
   *
   * 
   * repeated .google.cloud.retail.v2.SolutionType solution_types = 6 [(.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. The solution types that the control is used for.
   * Currently we support setting only one type of solution at creation time.
   *
   * Only `SOLUTION_TYPE_SEARCH` value is supported at the moment.
   * If no solution type is provided at creation time, will default to
   * [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2.SolutionType.SOLUTION_TYPE_SEARCH].
   * 
   *
   * 
   * repeated .google.cloud.retail.v2.SolutionType solution_types = 6 [(.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. The solution types that the control is used for.
   * Currently we support setting only one type of solution at creation time.
   *
   * Only `SOLUTION_TYPE_SEARCH` value is supported at the moment.
   * If no solution type is provided at creation time, will default to
   * [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2.SolutionType.SOLUTION_TYPE_SEARCH].
   * 
   *
   * 
   * repeated .google.cloud.retail.v2.SolutionType solution_types = 6 [(.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);

  /**
   *
   *
   *    * Specifies the use case for the control.
   * Affects what condition fields can be set.
   * Only settable by search controls.
   * Will default to
   * [SEARCH_SOLUTION_USE_CASE_SEARCH][google.cloud.retail.v2.SearchSolutionUseCase.SEARCH_SOLUTION_USE_CASE_SEARCH]
   * if not specified. Currently only allow one search_solution_use_case per
   * control.
   * 
   *
   * repeated .google.cloud.retail.v2.SearchSolutionUseCase search_solution_use_case = 7;
   * 
   *
   * @return A list containing the searchSolutionUseCase.
   */
  java.util.List getSearchSolutionUseCaseList();
  /**
   *
   *
   *    * Specifies the use case for the control.
   * Affects what condition fields can be set.
   * Only settable by search controls.
   * Will default to
   * [SEARCH_SOLUTION_USE_CASE_SEARCH][google.cloud.retail.v2.SearchSolutionUseCase.SEARCH_SOLUTION_USE_CASE_SEARCH]
   * if not specified. Currently only allow one search_solution_use_case per
   * control.
   * 
   *
   * repeated .google.cloud.retail.v2.SearchSolutionUseCase search_solution_use_case = 7;
   * 
   *
   * @return The count of searchSolutionUseCase.
   */
  int getSearchSolutionUseCaseCount();
  /**
   *
   *
   *    * Specifies the use case for the control.
   * Affects what condition fields can be set.
   * Only settable by search controls.
   * Will default to
   * [SEARCH_SOLUTION_USE_CASE_SEARCH][google.cloud.retail.v2.SearchSolutionUseCase.SEARCH_SOLUTION_USE_CASE_SEARCH]
   * if not specified. Currently only allow one search_solution_use_case per
   * control.
   * 
   *
   * repeated .google.cloud.retail.v2.SearchSolutionUseCase search_solution_use_case = 7;
   * 
   *
   * @param index The index of the element to return.
   * @return The searchSolutionUseCase at the given index.
   */
  com.google.cloud.retail.v2.SearchSolutionUseCase getSearchSolutionUseCase(int index);
  /**
   *
   *
   *    * Specifies the use case for the control.
   * Affects what condition fields can be set.
   * Only settable by search controls.
   * Will default to
   * [SEARCH_SOLUTION_USE_CASE_SEARCH][google.cloud.retail.v2.SearchSolutionUseCase.SEARCH_SOLUTION_USE_CASE_SEARCH]
   * if not specified. Currently only allow one search_solution_use_case per
   * control.
   * 
   *
   * repeated .google.cloud.retail.v2.SearchSolutionUseCase search_solution_use_case = 7;
   * 
   *
   * @return A list containing the enum numeric values on the wire for searchSolutionUseCase.
   */
  java.util.List getSearchSolutionUseCaseValueList();
  /**
   *
   *
   *    * Specifies the use case for the control.
   * Affects what condition fields can be set.
   * Only settable by search controls.
   * Will default to
   * [SEARCH_SOLUTION_USE_CASE_SEARCH][google.cloud.retail.v2.SearchSolutionUseCase.SEARCH_SOLUTION_USE_CASE_SEARCH]
   * if not specified. Currently only allow one search_solution_use_case per
   * control.
   * 
   *
   * repeated .google.cloud.retail.v2.SearchSolutionUseCase search_solution_use_case = 7;
   * 
   *
   * @param index The index of the value to return.
   * @return The enum numeric value on the wire of searchSolutionUseCase at the given index.
   */
  int getSearchSolutionUseCaseValue(int index);

  com.google.cloud.retail.v2.Control.ControlCase getControlCase();
}