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

  /**
   *    * Nested path to search against assuming same index as the parent Query.
   * 
   *
   * string query_nested_path = 1;
   * @return The queryNestedPath.
   */
  java.lang.String getQueryNestedPath();
  /**
   *    * Nested path to search against assuming same index as the parent Query.
   * 
   *
   * string query_nested_path = 1;
   * @return The bytes for queryNestedPath.
   */
  com.google.protobuf.ByteString
      getQueryNestedPathBytes();

  /**
   *    * Which hit to start from (for pagination); default: 0
   * 
   *
   * int32 start_hit = 2;
   * @return The startHit.
   */
  int getStartHit();

  /**
   *    * How many top hits to retrieve; default: 3. It limits the hits returned, starting from index 0. For pagination: set it to startHit + window_size.
   * 
   *
   * int32 top_hits = 3;
   * @return The topHits.
   */
  int getTopHits();

  /**
   *    * InnerHit query to query against the nested documents specified by queryNestedPath.
   * 
   *
   * .luceneserver.Query inner_query = 4;
   * @return Whether the innerQuery field is set.
   */
  boolean hasInnerQuery();
  /**
   *    * InnerHit query to query against the nested documents specified by queryNestedPath.
   * 
   *
   * .luceneserver.Query inner_query = 4;
   * @return The innerQuery.
   */
  com.yelp.nrtsearch.server.grpc.Query getInnerQuery();
  /**
   *    * InnerHit query to query against the nested documents specified by queryNestedPath.
   * 
   *
   * .luceneserver.Query inner_query = 4;
   */
  com.yelp.nrtsearch.server.grpc.QueryOrBuilder getInnerQueryOrBuilder();

  /**
   *    * Fields to retrieve; Parent's fields except its id field are unavailable in the innerHit.
   * 
   *
   * repeated string retrieve_fields = 5;
   * @return A list containing the retrieveFields.
   */
  java.util.List
      getRetrieveFieldsList();
  /**
   *    * Fields to retrieve; Parent's fields except its id field are unavailable in the innerHit.
   * 
   *
   * repeated string retrieve_fields = 5;
   * @return The count of retrieveFields.
   */
  int getRetrieveFieldsCount();
  /**
   *    * Fields to retrieve; Parent's fields except its id field are unavailable in the innerHit.
   * 
   *
   * repeated string retrieve_fields = 5;
   * @param index The index of the element to return.
   * @return The retrieveFields at the given index.
   */
  java.lang.String getRetrieveFields(int index);
  /**
   *    * Fields to retrieve; Parent's fields except its id field are unavailable in the innerHit.
   * 
   *
   * repeated string retrieve_fields = 5;
   * @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);

  /**
   *    * Sort hits by field (default is by relevance).
   * 
   *
   * .luceneserver.QuerySortField query_sort = 6;
   * @return Whether the querySort field is set.
   */
  boolean hasQuerySort();
  /**
   *    * Sort hits by field (default is by relevance).
   * 
   *
   * .luceneserver.QuerySortField query_sort = 6;
   * @return The querySort.
   */
  com.yelp.nrtsearch.server.grpc.QuerySortField getQuerySort();
  /**
   *    * Sort hits by field (default is by relevance).
   * 
   *
   * .luceneserver.QuerySortField query_sort = 6;
   */
  com.yelp.nrtsearch.server.grpc.QuerySortFieldOrBuilder getQuerySortOrBuilder();

  /**
   *    * Highlight the children documents.
   * 
   *
   * .luceneserver.Highlight highlight = 7;
   * @return Whether the highlight field is set.
   */
  boolean hasHighlight();
  /**
   *    * Highlight the children documents.
   * 
   *
   * .luceneserver.Highlight highlight = 7;
   * @return The highlight.
   */
  com.yelp.nrtsearch.server.grpc.Highlight getHighlight();
  /**
   *    * Highlight the children documents.
   * 
   *
   * .luceneserver.Highlight highlight = 7;
   */
  com.yelp.nrtsearch.server.grpc.HighlightOrBuilder getHighlightOrBuilder();
}