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

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

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

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

  /**
   *
   *
   *    * Specifies the matching order for autocomplete suggestions, e.g., a query
   * consisting of 'sh' with 'out-of-order' specified would suggest "women's
   * shoes", whereas a query of 'red s' with 'exact-prefix' specified would
   * suggest "red shoes". Currently supported values:
   *
   * * 'out-of-order'
   * * 'exact-prefix'
   *
   * Default value: 'exact-prefix'.
   * 
   *
   * string matching_order = 2;
   *
   * @return The matchingOrder.
   */
  java.lang.String getMatchingOrder();
  /**
   *
   *
   *    * Specifies the matching order for autocomplete suggestions, e.g., a query
   * consisting of 'sh' with 'out-of-order' specified would suggest "women's
   * shoes", whereas a query of 'red s' with 'exact-prefix' specified would
   * suggest "red shoes". Currently supported values:
   *
   * * 'out-of-order'
   * * 'exact-prefix'
   *
   * Default value: 'exact-prefix'.
   * 
   *
   * string matching_order = 2;
   *
   * @return The bytes for matchingOrder.
   */
  com.google.protobuf.ByteString getMatchingOrderBytes();

  /**
   *
   *
   *    * The maximum number of autocomplete suggestions returned per term. Default
   * value is 20. If left unset or set to 0, then will fallback to default
   * value.
   *
   * Value range is 1 to 20.
   * 
   *
   * int32 max_suggestions = 3;
   *
   * @return The maxSuggestions.
   */
  int getMaxSuggestions();

  /**
   *
   *
   *    * The minimum number of characters needed to be typed in order to get
   * suggestions. Default value is 2. If left unset or set to 0, then will
   * fallback to default value.
   *
   * Value range is 1 to 20.
   * 
   *
   * int32 min_prefix_length = 4;
   *
   * @return The minPrefixLength.
   */
  int getMinPrefixLength();

  /**
   *
   *
   *    * If set to true, the auto learning function is enabled. Auto learning uses
   * user data to generate suggestions using ML techniques. Default value is
   * false. Only after enabling auto learning can users use `cloud-retail`
   * data in
   * [CompleteQueryRequest][google.cloud.retail.v2.CompleteQueryRequest].
   * 
   *
   * bool auto_learning = 11;
   *
   * @return The autoLearning.
   */
  boolean getAutoLearning();

  /**
   *
   *
   *    * Output only. The source data for the latest import of the autocomplete
   * suggestion phrases.
   * 
   *
   * 
   * .google.cloud.retail.v2.CompletionDataInputConfig suggestions_input_config = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * 
   *
   * @return Whether the suggestionsInputConfig field is set.
   */
  boolean hasSuggestionsInputConfig();
  /**
   *
   *
   *    * Output only. The source data for the latest import of the autocomplete
   * suggestion phrases.
   * 
   *
   * 
   * .google.cloud.retail.v2.CompletionDataInputConfig suggestions_input_config = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * 
   *
   * @return The suggestionsInputConfig.
   */
  com.google.cloud.retail.v2.CompletionDataInputConfig getSuggestionsInputConfig();
  /**
   *
   *
   *    * Output only. The source data for the latest import of the autocomplete
   * suggestion phrases.
   * 
   *
   * 
   * .google.cloud.retail.v2.CompletionDataInputConfig suggestions_input_config = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * 
   */
  com.google.cloud.retail.v2.CompletionDataInputConfigOrBuilder
      getSuggestionsInputConfigOrBuilder();

  /**
   *
   *
   *    * Output only. Name of the LRO corresponding to the latest suggestion terms
   * list import.
   *
   * Can use [GetOperation][google.longrunning.Operations.GetOperation] API
   * method to retrieve the latest state of the Long Running Operation.
   * 
   *
   * 
   * string last_suggestions_import_operation = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * 
   *
   * @return The lastSuggestionsImportOperation.
   */
  java.lang.String getLastSuggestionsImportOperation();
  /**
   *
   *
   *    * Output only. Name of the LRO corresponding to the latest suggestion terms
   * list import.
   *
   * Can use [GetOperation][google.longrunning.Operations.GetOperation] API
   * method to retrieve the latest state of the Long Running Operation.
   * 
   *
   * 
   * string last_suggestions_import_operation = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * 
   *
   * @return The bytes for lastSuggestionsImportOperation.
   */
  com.google.protobuf.ByteString getLastSuggestionsImportOperationBytes();

  /**
   *
   *
   *    * Output only. The source data for the latest import of the autocomplete
   * denylist phrases.
   * 
   *
   * 
   * .google.cloud.retail.v2.CompletionDataInputConfig denylist_input_config = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * 
   *
   * @return Whether the denylistInputConfig field is set.
   */
  boolean hasDenylistInputConfig();
  /**
   *
   *
   *    * Output only. The source data for the latest import of the autocomplete
   * denylist phrases.
   * 
   *
   * 
   * .google.cloud.retail.v2.CompletionDataInputConfig denylist_input_config = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * 
   *
   * @return The denylistInputConfig.
   */
  com.google.cloud.retail.v2.CompletionDataInputConfig getDenylistInputConfig();
  /**
   *
   *
   *    * Output only. The source data for the latest import of the autocomplete
   * denylist phrases.
   * 
   *
   * 
   * .google.cloud.retail.v2.CompletionDataInputConfig denylist_input_config = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * 
   */
  com.google.cloud.retail.v2.CompletionDataInputConfigOrBuilder getDenylistInputConfigOrBuilder();

  /**
   *
   *
   *    * Output only. Name of the LRO corresponding to the latest denylist import.
   *
   * Can use [GetOperation][google.longrunning.Operations.GetOperation] API to
   * retrieve the latest state of the Long Running Operation.
   * 
   *
   * string last_denylist_import_operation = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * 
   *
   * @return The lastDenylistImportOperation.
   */
  java.lang.String getLastDenylistImportOperation();
  /**
   *
   *
   *    * Output only. Name of the LRO corresponding to the latest denylist import.
   *
   * Can use [GetOperation][google.longrunning.Operations.GetOperation] API to
   * retrieve the latest state of the Long Running Operation.
   * 
   *
   * string last_denylist_import_operation = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * 
   *
   * @return The bytes for lastDenylistImportOperation.
   */
  com.google.protobuf.ByteString getLastDenylistImportOperationBytes();

  /**
   *
   *
   *    * Output only. The source data for the latest import of the autocomplete
   * allowlist phrases.
   * 
   *
   * 
   * .google.cloud.retail.v2.CompletionDataInputConfig allowlist_input_config = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * 
   *
   * @return Whether the allowlistInputConfig field is set.
   */
  boolean hasAllowlistInputConfig();
  /**
   *
   *
   *    * Output only. The source data for the latest import of the autocomplete
   * allowlist phrases.
   * 
   *
   * 
   * .google.cloud.retail.v2.CompletionDataInputConfig allowlist_input_config = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * 
   *
   * @return The allowlistInputConfig.
   */
  com.google.cloud.retail.v2.CompletionDataInputConfig getAllowlistInputConfig();
  /**
   *
   *
   *    * Output only. The source data for the latest import of the autocomplete
   * allowlist phrases.
   * 
   *
   * 
   * .google.cloud.retail.v2.CompletionDataInputConfig allowlist_input_config = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * 
   */
  com.google.cloud.retail.v2.CompletionDataInputConfigOrBuilder getAllowlistInputConfigOrBuilder();

  /**
   *
   *
   *    * Output only. Name of the LRO corresponding to the latest allowlist import.
   *
   * Can use [GetOperation][google.longrunning.Operations.GetOperation] API to
   * retrieve the latest state of the Long Running Operation.
   * 
   *
   * string last_allowlist_import_operation = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * 
   *
   * @return The lastAllowlistImportOperation.
   */
  java.lang.String getLastAllowlistImportOperation();
  /**
   *
   *
   *    * Output only. Name of the LRO corresponding to the latest allowlist import.
   *
   * Can use [GetOperation][google.longrunning.Operations.GetOperation] API to
   * retrieve the latest state of the Long Running Operation.
   * 
   *
   * string last_allowlist_import_operation = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * 
   *
   * @return The bytes for lastAllowlistImportOperation.
   */
  com.google.protobuf.ByteString getLastAllowlistImportOperationBytes();
}