com.yelp.nrtsearch.server.grpc.MultiMatchQueryOrBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of clientlib Show documentation
GRPC Clientlib for nrtSearch
There is a newer version: 1.0.0-beta.1
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: yelp/nrtsearch/search.proto

// Protobuf Java Version: 3.25.3
package com.yelp.nrtsearch.server.grpc;

public interface MultiMatchQueryOrBuilder extends
    // @@protoc_insertion_point(interface_extends:luceneserver.MultiMatchQuery)
    com.google.protobuf.MessageOrBuilder {

  /**
   *    * Fields in the document to query.
   * 
   *
   * repeated string fields = 1;
   * @return A list containing the fields.
   */
  java.util.List
      getFieldsList();
  /**
   *    * Fields in the document to query.
   * 
   *
   * repeated string fields = 1;
   * @return The count of fields.
   */
  int getFieldsCount();
  /**
   *    * Fields in the document to query.
   * 
   *
   * repeated string fields = 1;
   * @param index The index of the element to return.
   * @return The fields at the given index.
   */
  java.lang.String getFields(int index);
  /**
   *    * Fields in the document to query.
   * 
   *
   * repeated string fields = 1;
   * @param index The index of the value to return.
   * @return The bytes of the fields at the given index.
   */
  com.google.protobuf.ByteString
      getFieldsBytes(int index);

  /**
   *    * The text to query with.
   * 
   *
   * string query = 2;
   * @return The query.
   */
  java.lang.String getQuery();
  /**
   *    * The text to query with.
   * 
   *
   * string query = 2;
   * @return The bytes for query.
   */
  com.google.protobuf.ByteString
      getQueryBytes();

  /**
   *    * Boosts for each field, if any.
   * 
   *
   * map<string, float> fieldBoosts = 3;
   */
  int getFieldBoostsCount();
  /**
   *    * Boosts for each field, if any.
   * 
   *
   * map<string, float> fieldBoosts = 3;
   */
  boolean containsFieldBoosts(
      java.lang.String key);
  /**
   * Use {@link #getFieldBoostsMap()} instead.
   */
  @java.lang.Deprecated
  java.util.Map
  getFieldBoosts();
  /**
   *    * Boosts for each field, if any.
   * 
   *
   * map<string, float> fieldBoosts = 3;
   */
  java.util.Map
  getFieldBoostsMap();
  /**
   *    * Boosts for each field, if any.
   * 
   *
   * map<string, float> fieldBoosts = 3;
   */
  float getFieldBoostsOrDefault(
      java.lang.String key,
      float defaultValue);
  /**
   *    * Boosts for each field, if any.
   * 
   *
   * map<string, float> fieldBoosts = 3;
   */
  float getFieldBoostsOrThrow(
      java.lang.String key);

  /**
   *    * Boolean logic used to interpret text in the query. The possible values are SHOULD (default) and MUST.
   * 
   *
   * .luceneserver.MatchOperator operator = 4;
   * @return The enum numeric value on the wire for operator.
   */
  int getOperatorValue();
  /**
   *    * Boolean logic used to interpret text in the query. The possible values are SHOULD (default) and MUST.
   * 
   *
   * .luceneserver.MatchOperator operator = 4;
   * @return The operator.
   */
  com.yelp.nrtsearch.server.grpc.MatchOperator getOperator();

  /**
   *    * Minimum number of optional clauses that must match.
   * 
   *
   * int32 minimumNumberShouldMatch = 5;
   * @return The minimumNumberShouldMatch.
   */
  int getMinimumNumberShouldMatch();

  /**
   *    * Analyzer used to analyze the query. If not provided, the default search analyzer for the field would be used instead.
   * 
   *
   * .luceneserver.Analyzer analyzer = 6;
   * @return Whether the analyzer field is set.
   */
  boolean hasAnalyzer();
  /**
   *    * Analyzer used to analyze the query. If not provided, the default search analyzer for the field would be used instead.
   * 
   *
   * .luceneserver.Analyzer analyzer = 6;
   * @return The analyzer.
   */
  com.yelp.nrtsearch.server.grpc.Analyzer getAnalyzer();
  /**
   *    * Analyzer used to analyze the query. If not provided, the default search analyzer for the field would be used instead.
   * 
   *
   * .luceneserver.Analyzer analyzer = 6;
   */
  com.yelp.nrtsearch.server.grpc.AnalyzerOrBuilder getAnalyzerOrBuilder();

  /**
   *    * Parameters to set the fuzziness of the query
   * 
   *
   * .luceneserver.FuzzyParams fuzzyParams = 7;
   * @return Whether the fuzzyParams field is set.
   */
  boolean hasFuzzyParams();
  /**
   *    * Parameters to set the fuzziness of the query
   * 
   *
   * .luceneserver.FuzzyParams fuzzyParams = 7;
   * @return The fuzzyParams.
   */
  com.yelp.nrtsearch.server.grpc.FuzzyParams getFuzzyParams();
  /**
   *    * Parameters to set the fuzziness of the query
   * 
   *
   * .luceneserver.FuzzyParams fuzzyParams = 7;
   */
  com.yelp.nrtsearch.server.grpc.FuzzyParamsOrBuilder getFuzzyParamsOrBuilder();

  /**
   *    * The score of each non-maximum match query disjunct for a document will be multiplied by this weight and added into the final score.
   * 
   *
   * float tieBreakerMultiplier = 8;
   * @return The tieBreakerMultiplier.
   */
  float getTieBreakerMultiplier();

  /**
   *    * Type defining match behavior of query.
   * 
   *
   * .luceneserver.MultiMatchQuery.MatchType type = 9;
   * @return The enum numeric value on the wire for type.
   */
  int getTypeValue();
  /**
   *    * Type defining match behavior of query.
   * 
   *
   * .luceneserver.MultiMatchQuery.MatchType type = 9;
   * @return The type.
   */
  com.yelp.nrtsearch.server.grpc.MultiMatchQuery.MatchType getType();

  /**
   *    * Edit distance between respective positions of tokens generated by analyzing this query and the positions of terms in a document, applies to PHRASE_PREFIX type matching.
   * 
   *
   * int32 slop = 10;
   * @return The slop.
   */
  int getSlop();

  /**
   *    * Maximum number of terms to which the prefix token will expand when using PHRASE_PREFIX matching. Defaults to 50.
   * 
   *
   * int32 maxExpansions = 11;
   * @return The maxExpansions.
   */
  int getMaxExpansions();
}