com.yelp.nrtsearch.server.grpc.SuggestNonLocalSourceOrBuilder 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 SuggestNonLocalSourceOrBuilder extends
    // @@protoc_insertion_point(interface_extends:luceneserver.SuggestNonLocalSource)
    com.google.protobuf.MessageOrBuilder {

  /**
   *    *Search a generation previously returned by an indexing operation such as #addDocument.  Use this to search a non-committed (near-real-time) view of the index.
   * 
   *
   * int64 indexGen = 1;
   * @return Whether the indexGen field is set.
   */
  boolean hasIndexGen();
  /**
   *    *Search a generation previously returned by an indexing operation such as #addDocument.  Use this to search a non-committed (near-real-time) view of the index.
   * 
   *
   * int64 indexGen = 1;
   * @return The indexGen.
   */
  long getIndexGen();

  /**
   *    *Search a specific searcher version.  This is typically used by follow-on searches (e.g., user clicks next page, drills down, or changes sort, etc.) to get the same searcher used by the original search.
   * 
   *
   * int64 version = 2;
   * @return Whether the version field is set.
   */
  boolean hasVersion();
  /**
   *    *Search a specific searcher version.  This is typically used by follow-on searches (e.g., user clicks next page, drills down, or changes sort, etc.) to get the same searcher used by the original search.
   * 
   *
   * int64 version = 2;
   * @return The version.
   */
  long getVersion();

  /**
   *    *Search a snapshot previously created with #createSnapshot
   * 
   *
   * string snapshot = 3;
   * @return Whether the snapshot field is set.
   */
  boolean hasSnapshot();
  /**
   *    *Search a snapshot previously created with #createSnapshot
   * 
   *
   * string snapshot = 3;
   * @return The snapshot.
   */
  java.lang.String getSnapshot();
  /**
   *    *Search a snapshot previously created with #createSnapshot
   * 
   *
   * string snapshot = 3;
   * @return The bytes for snapshot.
   */
  com.google.protobuf.ByteString
      getSnapshotBytes();

  /**
   *    *Field (from stored documents) containing the suggestion text
   * 
   *
   * string suggestField = 4;
   * @return The suggestField.
   */
  java.lang.String getSuggestField();
  /**
   *    *Field (from stored documents) containing the suggestion text
   * 
   *
   * string suggestField = 4;
   * @return The bytes for suggestField.
   */
  com.google.protobuf.ByteString
      getSuggestFieldBytes();

  /**
   *    *Numeric field (from stored documents) containing the weight
   * 
   *
   * string weightField = 5;
   * @return Whether the weightField field is set.
   */
  boolean hasWeightField();
  /**
   *    *Numeric field (from stored documents) containing the weight
   * 
   *
   * string weightField = 5;
   * @return The weightField.
   */
  java.lang.String getWeightField();
  /**
   *    *Numeric field (from stored documents) containing the weight
   * 
   *
   * string weightField = 5;
   * @return The bytes for weightField.
   */
  com.google.protobuf.ByteString
      getWeightFieldBytes();

  /**
   *    *Alternative to weightField, an expression that's evaluated to the weight. Note that any fields referenced in the expression must have been indexed with sort=true
   * 
   *
   * string weightExpression = 6;
   * @return Whether the weightExpression field is set.
   */
  boolean hasWeightExpression();
  /**
   *    *Alternative to weightField, an expression that's evaluated to the weight. Note that any fields referenced in the expression must have been indexed with sort=true
   * 
   *
   * string weightExpression = 6;
   * @return The weightExpression.
   */
  java.lang.String getWeightExpression();
  /**
   *    *Alternative to weightField, an expression that's evaluated to the weight. Note that any fields referenced in the expression must have been indexed with sort=true
   * 
   *
   * string weightExpression = 6;
   * @return The bytes for weightExpression.
   */
  com.google.protobuf.ByteString
      getWeightExpressionBytes();

  /**
   *    *Optional binary or string field (from stored documents) containing the payload
   * 
   *
   * string payloadField = 7;
   * @return The payloadField.
   */
  java.lang.String getPayloadField();
  /**
   *    *Optional binary or string field (from stored documents) containing the payload
   * 
   *
   * string payloadField = 7;
   * @return The bytes for payloadField.
   */
  com.google.protobuf.ByteString
      getPayloadFieldBytes();

  /**
   *    *Numeric field (from stored documents) containing the context which can be later filtered on during lookup
   * 
   *
   * string contextField = 8;
   * @return The contextField.
   */
  java.lang.String getContextField();
  /**
   *    *Numeric field (from stored documents) containing the context which can be later filtered on during lookup
   * 
   *
   * string contextField = 8;
   * @return The bytes for contextField.
   */
  com.google.protobuf.ByteString
      getContextFieldBytes();

  /**
   *    *Binary or string field (from stored documents) containing the multiple search texts
   * 
   *
   * string searchTextField = 9;
   * @return The searchTextField.
   */
  java.lang.String getSearchTextField();
  /**
   *    *Binary or string field (from stored documents) containing the multiple search texts
   * 
   *
   * string searchTextField = 9;
   * @return The bytes for searchTextField.
   */
  com.google.protobuf.ByteString
      getSearchTextFieldBytes();

  com.yelp.nrtsearch.server.grpc.SuggestNonLocalSource.SearcherCase getSearcherCase();

  com.yelp.nrtsearch.server.grpc.SuggestNonLocalSource.WeightCase getWeightCase();
}