com.yelp.nrtsearch.server.grpc.SuggestLookupRequestOrBuilder 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/suggest.proto

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

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

  /**
   *    *Index name
   * 
   *
   * string indexName = 1;
   * @return The indexName.
   */
  java.lang.String getIndexName();
  /**
   *    *Index name
   * 
   *
   * string indexName = 1;
   * @return The bytes for indexName.
   */
  com.google.protobuf.ByteString
      getIndexNameBytes();

  /**
   *    *Which suggester to use
   * 
   *
   * string suggestName = 2;
   * @return The suggestName.
   */
  java.lang.String getSuggestName();
  /**
   *    *Which suggester to use
   * 
   *
   * string suggestName = 2;
   * @return The bytes for suggestName.
   */
  com.google.protobuf.ByteString
      getSuggestNameBytes();

  /**
   *    *Text to suggest from
   * 
   *
   * string text = 3;
   * @return The text.
   */
  java.lang.String getText();
  /**
   *    *Text to suggest from
   * 
   *
   * string text = 3;
   * @return The bytes for text.
   */
  com.google.protobuf.ByteString
      getTextBytes();

  /**
   *    *True if the suggestions should be highlighted (currently only works with AnalyzingInfixSuggester)
   * 
   *
   * bool highlight = 4;
   * @return The highlight.
   */
  boolean getHighlight();

  /**
   *    *If true then all terms must be found (this only applies to InfixSuggester currently)
   * 
   *
   * bool allTermsRequired = 5;
   * @return The allTermsRequired.
   */
  boolean getAllTermsRequired();

  /**
   *    *Which contexts to filter by
   * 
   *
   * repeated string contexts = 6;
   * @return A list containing the contexts.
   */
  java.util.List
      getContextsList();
  /**
   *    *Which contexts to filter by
   * 
   *
   * repeated string contexts = 6;
   * @return The count of contexts.
   */
  int getContextsCount();
  /**
   *    *Which contexts to filter by
   * 
   *
   * repeated string contexts = 6;
   * @param index The index of the element to return.
   * @return The contexts at the given index.
   */
  java.lang.String getContexts(int index);
  /**
   *    *Which contexts to filter by
   * 
   *
   * repeated string contexts = 6;
   * @param index The index of the value to return.
   * @return The bytes of the contexts at the given index.
   */
  com.google.protobuf.ByteString
      getContextsBytes(int index);

  /**
   *    *How many suggestions to return, default = 5
   * 
   *
   * int32 count = 7;
   * @return The count.
   */
  int getCount();
}