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

  /**
   *    *Offset for retrieval of top hits.
   * 
   *
   * int32 startHit = 1;
   * @return The startHit.
   */
  int getStartHit();

  /**
   *    *Total hits to collect, note that the number of hits returned is (topHits - startHit).
   * 
   *
   * int32 topHits = 2;
   * @return The topHits.
   */
  int getTopHits();

  /**
   *    *When specified, collector does sort based collection. Otherwise, relevance score is used.
   * 
   *
   * .luceneserver.QuerySortField querySort = 3;
   * @return Whether the querySort field is set.
   */
  boolean hasQuerySort();
  /**
   *    *When specified, collector does sort based collection. Otherwise, relevance score is used.
   * 
   *
   * .luceneserver.QuerySortField querySort = 3;
   * @return The querySort.
   */
  com.yelp.nrtsearch.server.grpc.QuerySortField getQuerySort();
  /**
   *    *When specified, collector does sort based collection. Otherwise, relevance score is used.
   * 
   *
   * .luceneserver.QuerySortField querySort = 3;
   */
  com.yelp.nrtsearch.server.grpc.QuerySortFieldOrBuilder getQuerySortOrBuilder();

  /**
   *    *Which fields to retrieve.
   * 
   *
   * repeated string retrieveFields = 4;
   * @return A list containing the retrieveFields.
   */
  java.util.List
      getRetrieveFieldsList();
  /**
   *    *Which fields to retrieve.
   * 
   *
   * repeated string retrieveFields = 4;
   * @return The count of retrieveFields.
   */
  int getRetrieveFieldsCount();
  /**
   *    *Which fields to retrieve.
   * 
   *
   * repeated string retrieveFields = 4;
   * @param index The index of the element to return.
   * @return The retrieveFields at the given index.
   */
  java.lang.String getRetrieveFields(int index);
  /**
   *    *Which fields to retrieve.
   * 
   *
   * repeated string retrieveFields = 4;
   * @param index The index of the value to return.
   * @return The bytes of the retrieveFields at the given index.
   */
  com.google.protobuf.ByteString
      getRetrieveFieldsBytes(int index);

  /**
   *    * If Lucene explanation should be included in the collector response
   * 
   *
   * bool explain = 5;
   * @return The explain.
   */
  boolean getExplain();
}