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

  /**
   *    *Dimension (field)
   * 
   *
   * string dim = 1;
   * @return The dim.
   */
  java.lang.String getDim();
  /**
   *    *Dimension (field)
   * 
   *
   * string dim = 1;
   * @return The bytes for dim.
   */
  com.google.protobuf.ByteString
      getDimBytes();

  /**
   *    *Prefix path to facet 'under'
   * 
   *
   * repeated string paths = 2;
   * @return A list containing the paths.
   */
  java.util.List
      getPathsList();
  /**
   *    *Prefix path to facet 'under'
   * 
   *
   * repeated string paths = 2;
   * @return The count of paths.
   */
  int getPathsCount();
  /**
   *    *Prefix path to facet 'under'
   * 
   *
   * repeated string paths = 2;
   * @param index The index of the element to return.
   * @return The paths at the given index.
   */
  java.lang.String getPaths(int index);
  /**
   *    *Prefix path to facet 'under'
   * 
   *
   * repeated string paths = 2;
   * @param index The index of the value to return.
   * @return The bytes of the paths at the given index.
   */
  com.google.protobuf.ByteString
      getPathsBytes(int index);

  /**
   *    *Custom numeric ranges.  Field must be indexed with facet=numericRange.
   * 
   *
   * repeated .luceneserver.NumericRangeType numericRange = 3;
   */
  java.util.List 
      getNumericRangeList();
  /**
   *    *Custom numeric ranges.  Field must be indexed with facet=numericRange.
   * 
   *
   * repeated .luceneserver.NumericRangeType numericRange = 3;
   */
  com.yelp.nrtsearch.server.grpc.NumericRangeType getNumericRange(int index);
  /**
   *    *Custom numeric ranges.  Field must be indexed with facet=numericRange.
   * 
   *
   * repeated .luceneserver.NumericRangeType numericRange = 3;
   */
  int getNumericRangeCount();
  /**
   *    *Custom numeric ranges.  Field must be indexed with facet=numericRange.
   * 
   *
   * repeated .luceneserver.NumericRangeType numericRange = 3;
   */
  java.util.List 
      getNumericRangeOrBuilderList();
  /**
   *    *Custom numeric ranges.  Field must be indexed with facet=numericRange.
   * 
   *
   * repeated .luceneserver.NumericRangeType numericRange = 3;
   */
  com.yelp.nrtsearch.server.grpc.NumericRangeTypeOrBuilder getNumericRangeOrBuilder(
      int index);

  /**
   *    * True if the ordinals cache should be used
   * 
   *
   * bool useOrdsCache = 4;
   * @return The useOrdsCache.
   */
  boolean getUseOrdsCache();

  /**
   *    * Specific facet labels to retrieve
   * 
   *
   * repeated string labels = 5;
   * @return A list containing the labels.
   */
  java.util.List
      getLabelsList();
  /**
   *    * Specific facet labels to retrieve
   * 
   *
   * repeated string labels = 5;
   * @return The count of labels.
   */
  int getLabelsCount();
  /**
   *    * Specific facet labels to retrieve
   * 
   *
   * repeated string labels = 5;
   * @param index The index of the element to return.
   * @return The labels at the given index.
   */
  java.lang.String getLabels(int index);
  /**
   *    * Specific facet labels to retrieve
   * 
   *
   * repeated string labels = 5;
   * @param index The index of the value to return.
   * @return The bytes of the labels at the given index.
   */
  com.google.protobuf.ByteString
      getLabelsBytes(int index);

  /**
   *    *How many top facets to return
   * 
   *
   * int32 topN = 6;
   * @return The topN.
   */
  int getTopN();

  /**
   *    *FacetScript definition to use in place of index facet
   * 
   *
   * .luceneserver.Script script = 7;
   * @return Whether the script field is set.
   */
  boolean hasScript();
  /**
   *    *FacetScript definition to use in place of index facet
   * 
   *
   * .luceneserver.Script script = 7;
   * @return The script.
   */
  com.yelp.nrtsearch.server.grpc.Script getScript();
  /**
   *    *FacetScript definition to use in place of index facet
   * 
   *
   * .luceneserver.Script script = 7;
   */
  com.yelp.nrtsearch.server.grpc.ScriptOrBuilder getScriptOrBuilder();

  /**
   *    *Facet over the top N ranked documents, instead of all hits. Only works with field doc values.
   * 
   *
   * int32 sampleTopDocs = 8;
   * @return The sampleTopDocs.
   */
  int getSampleTopDocs();

  /**
   *    *Name for this facet
   * 
   *
   * string name = 9;
   * @return The name.
   */
  java.lang.String getName();
  /**
   *    *Name for this facet
   * 
   *
   * string name = 9;
   * @return The bytes for name.
   */
  com.google.protobuf.ByteString
      getNameBytes();
}