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

  /**
   * .luceneserver.SearchResponse.Diagnostics diagnostics = 1;
   * @return Whether the diagnostics field is set.
   */
  boolean hasDiagnostics();
  /**
   * .luceneserver.SearchResponse.Diagnostics diagnostics = 1;
   * @return The diagnostics.
   */
  com.yelp.nrtsearch.server.grpc.SearchResponse.Diagnostics getDiagnostics();
  /**
   * .luceneserver.SearchResponse.Diagnostics diagnostics = 1;
   */
  com.yelp.nrtsearch.server.grpc.SearchResponse.DiagnosticsOrBuilder getDiagnosticsOrBuilder();

  /**
   *    * Set to true if search times out and a degraded response is returned
   * 
   *
   * bool hitTimeout = 2;
   * @return The hitTimeout.
   */
  boolean getHitTimeout();

  /**
   * .luceneserver.TotalHits totalHits = 3;
   * @return Whether the totalHits field is set.
   */
  boolean hasTotalHits();
  /**
   * .luceneserver.TotalHits totalHits = 3;
   * @return The totalHits.
   */
  com.yelp.nrtsearch.server.grpc.TotalHits getTotalHits();
  /**
   * .luceneserver.TotalHits totalHits = 3;
   */
  com.yelp.nrtsearch.server.grpc.TotalHitsOrBuilder getTotalHitsOrBuilder();

  /**
   * repeated .luceneserver.SearchResponse.Hit hits = 4;
   */
  java.util.List 
      getHitsList();
  /**
   * repeated .luceneserver.SearchResponse.Hit hits = 4;
   */
  com.yelp.nrtsearch.server.grpc.SearchResponse.Hit getHits(int index);
  /**
   * repeated .luceneserver.SearchResponse.Hit hits = 4;
   */
  int getHitsCount();
  /**
   * repeated .luceneserver.SearchResponse.Hit hits = 4;
   */
  java.util.List 
      getHitsOrBuilderList();
  /**
   * repeated .luceneserver.SearchResponse.Hit hits = 4;
   */
  com.yelp.nrtsearch.server.grpc.SearchResponse.HitOrBuilder getHitsOrBuilder(
      int index);

  /**
   * .luceneserver.SearchResponse.SearchState searchState = 5;
   * @return Whether the searchState field is set.
   */
  boolean hasSearchState();
  /**
   * .luceneserver.SearchResponse.SearchState searchState = 5;
   * @return The searchState.
   */
  com.yelp.nrtsearch.server.grpc.SearchResponse.SearchState getSearchState();
  /**
   * .luceneserver.SearchResponse.SearchState searchState = 5;
   */
  com.yelp.nrtsearch.server.grpc.SearchResponse.SearchStateOrBuilder getSearchStateOrBuilder();

  /**
   *    *//Counts or aggregates for a single dimension
   * 
   *
   * repeated .luceneserver.FacetResult facetResult = 6;
   */
  java.util.List 
      getFacetResultList();
  /**
   *    *//Counts or aggregates for a single dimension
   * 
   *
   * repeated .luceneserver.FacetResult facetResult = 6;
   */
  com.yelp.nrtsearch.server.grpc.FacetResult getFacetResult(int index);
  /**
   *    *//Counts or aggregates for a single dimension
   * 
   *
   * repeated .luceneserver.FacetResult facetResult = 6;
   */
  int getFacetResultCount();
  /**
   *    *//Counts or aggregates for a single dimension
   * 
   *
   * repeated .luceneserver.FacetResult facetResult = 6;
   */
  java.util.List 
      getFacetResultOrBuilderList();
  /**
   *    *//Counts or aggregates for a single dimension
   * 
   *
   * repeated .luceneserver.FacetResult facetResult = 6;
   */
  com.yelp.nrtsearch.server.grpc.FacetResultOrBuilder getFacetResultOrBuilder(
      int index);

  /**
   *    * Detailed stats returned when profile=true in request
   * 
   *
   * .luceneserver.ProfileResult profileResult = 7;
   * @return Whether the profileResult field is set.
   */
  boolean hasProfileResult();
  /**
   *    * Detailed stats returned when profile=true in request
   * 
   *
   * .luceneserver.ProfileResult profileResult = 7;
   * @return The profileResult.
   */
  com.yelp.nrtsearch.server.grpc.ProfileResult getProfileResult();
  /**
   *    * Detailed stats returned when profile=true in request
   * 
   *
   * .luceneserver.ProfileResult profileResult = 7;
   */
  com.yelp.nrtsearch.server.grpc.ProfileResultOrBuilder getProfileResultOrBuilder();

  /**
   *    * Results from any additional document collectors
   * 
   *
   * map<string, .luceneserver.CollectorResult> collectorResults = 8;
   */
  int getCollectorResultsCount();
  /**
   *    * Results from any additional document collectors
   * 
   *
   * map<string, .luceneserver.CollectorResult> collectorResults = 8;
   */
  boolean containsCollectorResults(
      java.lang.String key);
  /**
   * Use {@link #getCollectorResultsMap()} instead.
   */
  @java.lang.Deprecated
  java.util.Map
  getCollectorResults();
  /**
   *    * Results from any additional document collectors
   * 
   *
   * map<string, .luceneserver.CollectorResult> collectorResults = 8;
   */
  java.util.Map
  getCollectorResultsMap();
  /**
   *    * Results from any additional document collectors
   * 
   *
   * map<string, .luceneserver.CollectorResult> collectorResults = 8;
   */
  /* nullable */
com.yelp.nrtsearch.server.grpc.CollectorResult getCollectorResultsOrDefault(
      java.lang.String key,
      /* nullable */
com.yelp.nrtsearch.server.grpc.CollectorResult defaultValue);
  /**
   *    * Results from any additional document collectors
   * 
   *
   * map<string, .luceneserver.CollectorResult> collectorResults = 8;
   */
  com.yelp.nrtsearch.server.grpc.CollectorResult getCollectorResultsOrThrow(
      java.lang.String key);

  /**
   *    * If this query hit the terminateAfter threshold specified in the request
   * 
   *
   * bool terminatedEarly = 9;
   * @return The terminatedEarly.
   */
  boolean getTerminatedEarly();
}