com.yelp.nrtsearch.server.grpc.SettingsRequestOrBuilder 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/luceneserver.proto

// Protobuf Java Version: 3.25.3
package com.yelp.nrtsearch.server.grpc;

public interface SettingsRequestOrBuilder extends
    // @@protoc_insertion_point(interface_extends:luceneserver.SettingsRequest)
    com.google.protobuf.MessageOrBuilder {

  /**
   *    * Index name
   * 
   *
   * string indexName = 1;
   * @return The indexName.
   */
  java.lang.String getIndexName();
  /**
   *    * Index name
   * 
   *
   * string indexName = 1;
   * @return The bytes for indexName.
   */
  com.google.protobuf.ByteString
      getIndexNameBytes();

  /**
   *    * Rate limit merges to at most this many MB/sec
   * 
   *
   * double mergeMaxMBPerSec = 2;
   * @return The mergeMaxMBPerSec.
   */
  double getMergeMaxMBPerSec();

  /**
   *    * Largest merged segment size to cache in RAMDirectory, default: 5.0MB
   * 
   *
   * double nrtCachingDirectoryMaxMergeSizeMB = 3;
   * @return The nrtCachingDirectoryMaxMergeSizeMB.
   */
  double getNrtCachingDirectoryMaxMergeSizeMB();

  /**
   *    * Largest overall size for all files cached in NRTCachingDirectory; set to -1 to disable NRTCachingDirectory default: 60.0MB
   * 
   *
   * double nrtCachingDirectoryMaxSizeMB = 4;
   * @return The nrtCachingDirectoryMaxSizeMB.
   */
  double getNrtCachingDirectoryMaxSizeMB();

  /**
   *    * How many merge threads to allow at once
   * 
   *
   * int32 concurrentMergeSchedulerMaxThreadCount = 5;
   * @return The concurrentMergeSchedulerMaxThreadCount.
   */
  int getConcurrentMergeSchedulerMaxThreadCount();

  /**
   *    * Maximum backlog of pending merges before indexing threads are stalled
   * 
   *
   * int32 concurrentMergeSchedulerMaxMergeCount = 6;
   * @return The concurrentMergeSchedulerMaxMergeCount.
   */
  int getConcurrentMergeSchedulerMaxMergeCount();

  /**
   *    * Index time sorting; can only be written once", SearchHandler.SORT_TYPE
   * 
   *
   * .luceneserver.SortFields indexSort = 7;
   * @return Whether the indexSort field is set.
   */
  boolean hasIndexSort();
  /**
   *    * Index time sorting; can only be written once", SearchHandler.SORT_TYPE
   * 
   *
   * .luceneserver.SortFields indexSort = 7;
   * @return The indexSort.
   */
  com.yelp.nrtsearch.server.grpc.SortFields getIndexSort();
  /**
   *    * Index time sorting; can only be written once", SearchHandler.SORT_TYPE
   * 
   *
   * .luceneserver.SortFields indexSort = 7;
   */
  com.yelp.nrtsearch.server.grpc.SortFieldsOrBuilder getIndexSortOrBuilder();

  /**
   *    * Deprecated, moved to lucene config. Turn on IndexWriter's infoStream (to stdout)
   * 
   *
   * bool indexVerbose = 8 [deprecated = true];
   * @deprecated luceneserver.SettingsRequest.indexVerbose is deprecated.
   *     See yelp/nrtsearch/luceneserver.proto;l=648
   * @return The indexVerbose.
   */
  @java.lang.Deprecated boolean getIndexVerbose();

  /**
   *    * Turn on/off the merge scheduler's auto throttling
   * 
   *
   * bool indexMergeSchedulerAutoThrottle = 9;
   * @return The indexMergeSchedulerAutoThrottle.
   */
  boolean getIndexMergeSchedulerAutoThrottle();

  /**
   *    * Which NormsFormat should be used for all indexed fields. default: Lucene80NormsFormat
   * 
   *
   * string normsFormat = 10;
   * @return The normsFormat.
   */
  java.lang.String getNormsFormat();
  /**
   *    * Which NormsFormat should be used for all indexed fields. default: Lucene80NormsFormat
   * 
   *
   * string normsFormat = 10;
   * @return The bytes for normsFormat.
   */
  com.google.protobuf.ByteString
      getNormsFormatBytes();

  /**
   *    * Base Directory implementation to use (NRTCachingDirectory will wrap this) either one of the core implementations (FSDirectory, MMapDirectory, NIOFSDirectory, or a fully qualified path to a Directory implementation that has a public constructor taking a single File argument default: FSDirectory
   * 
   *
   * string directory = 11;
   * @return The directory.
   */
  java.lang.String getDirectory();
  /**
   *    * Base Directory implementation to use (NRTCachingDirectory will wrap this) either one of the core implementations (FSDirectory, MMapDirectory, NIOFSDirectory, or a fully qualified path to a Directory implementation that has a public constructor taking a single File argument default: FSDirectory
   * 
   *
   * string directory = 11;
   * @return The bytes for directory.
   */
  com.google.protobuf.ByteString
      getDirectoryBytes();
}