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

  /**
   *    * Highlight settings
   * 
   *
   * .luceneserver.Highlight.Settings settings = 1;
   * @return Whether the settings field is set.
   */
  boolean hasSettings();
  /**
   *    * Highlight settings
   * 
   *
   * .luceneserver.Highlight.Settings settings = 1;
   * @return The settings.
   */
  com.yelp.nrtsearch.server.grpc.Highlight.Settings getSettings();
  /**
   *    * Highlight settings
   * 
   *
   * .luceneserver.Highlight.Settings settings = 1;
   */
  com.yelp.nrtsearch.server.grpc.Highlight.SettingsOrBuilder getSettingsOrBuilder();

  /**
   *    * Fields to highlight
   * 
   *
   * repeated string fields = 2;
   * @return A list containing the fields.
   */
  java.util.List
      getFieldsList();
  /**
   *    * Fields to highlight
   * 
   *
   * repeated string fields = 2;
   * @return The count of fields.
   */
  int getFieldsCount();
  /**
   *    * Fields to highlight
   * 
   *
   * repeated string fields = 2;
   * @param index The index of the element to return.
   * @return The fields at the given index.
   */
  java.lang.String getFields(int index);
  /**
   *    * Fields to highlight
   * 
   *
   * repeated string fields = 2;
   * @param index The index of the value to return.
   * @return The bytes of the fields at the given index.
   */
  com.google.protobuf.ByteString
      getFieldsBytes(int index);

  /**
   *    * Map of field name to highlight settings for field, overrides request level highlight settings
   * 
   *
   * map<string, .luceneserver.Highlight.Settings> field_settings = 3;
   */
  int getFieldSettingsCount();
  /**
   *    * Map of field name to highlight settings for field, overrides request level highlight settings
   * 
   *
   * map<string, .luceneserver.Highlight.Settings> field_settings = 3;
   */
  boolean containsFieldSettings(
      java.lang.String key);
  /**
   * Use {@link #getFieldSettingsMap()} instead.
   */
  @java.lang.Deprecated
  java.util.Map
  getFieldSettings();
  /**
   *    * Map of field name to highlight settings for field, overrides request level highlight settings
   * 
   *
   * map<string, .luceneserver.Highlight.Settings> field_settings = 3;
   */
  java.util.Map
  getFieldSettingsMap();
  /**
   *    * Map of field name to highlight settings for field, overrides request level highlight settings
   * 
   *
   * map<string, .luceneserver.Highlight.Settings> field_settings = 3;
   */
  /* nullable */
com.yelp.nrtsearch.server.grpc.Highlight.Settings getFieldSettingsOrDefault(
      java.lang.String key,
      /* nullable */
com.yelp.nrtsearch.server.grpc.Highlight.Settings defaultValue);
  /**
   *    * Map of field name to highlight settings for field, overrides request level highlight settings
   * 
   *
   * map<string, .luceneserver.Highlight.Settings> field_settings = 3;
   */
  com.yelp.nrtsearch.server.grpc.Highlight.Settings getFieldSettingsOrThrow(
      java.lang.String key);
}