Class SearchRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
org.opensearch.protobufs.SearchRequest
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable, SearchRequestOrBuilder

public final class SearchRequest extends com.google.protobuf.GeneratedMessageV3 implements SearchRequestOrBuilder
Protobuf type SearchRequest
See Also:
  • Field Details

    • INDEX_FIELD_NUMBER

      public static final int INDEX_FIELD_NUMBER
      See Also:
    • X_SOURCE_FIELD_NUMBER

      public static final int X_SOURCE_FIELD_NUMBER
      See Also:
    • X_SOURCE_EXCLUDES_FIELD_NUMBER

      public static final int X_SOURCE_EXCLUDES_FIELD_NUMBER
      See Also:
    • X_SOURCE_INCLUDES_FIELD_NUMBER

      public static final int X_SOURCE_INCLUDES_FIELD_NUMBER
      See Also:
    • ALLOW_NO_INDICES_FIELD_NUMBER

      public static final int ALLOW_NO_INDICES_FIELD_NUMBER
      See Also:
    • ALLOW_PARTIAL_SEARCH_RESULTS_FIELD_NUMBER

      public static final int ALLOW_PARTIAL_SEARCH_RESULTS_FIELD_NUMBER
      See Also:
    • ANALYZE_WILDCARD_FIELD_NUMBER

      public static final int ANALYZE_WILDCARD_FIELD_NUMBER
      See Also:
    • ANALYZER_FIELD_NUMBER

      public static final int ANALYZER_FIELD_NUMBER
      See Also:
    • BATCHED_REDUCE_SIZE_FIELD_NUMBER

      public static final int BATCHED_REDUCE_SIZE_FIELD_NUMBER
      See Also:
    • CANCEL_AFTER_TIME_INTERVAL_FIELD_NUMBER

      public static final int CANCEL_AFTER_TIME_INTERVAL_FIELD_NUMBER
      See Also:
    • CCS_MINIMIZE_ROUNDTRIPS_FIELD_NUMBER

      public static final int CCS_MINIMIZE_ROUNDTRIPS_FIELD_NUMBER
      See Also:
    • DEFAULT_OPERATOR_FIELD_NUMBER

      public static final int DEFAULT_OPERATOR_FIELD_NUMBER
      See Also:
    • DF_FIELD_NUMBER

      public static final int DF_FIELD_NUMBER
      See Also:
    • DOCVALUE_FIELDS_FIELD_NUMBER

      public static final int DOCVALUE_FIELDS_FIELD_NUMBER
      See Also:
    • EXPAND_WILDCARDS_FIELD_NUMBER

      public static final int EXPAND_WILDCARDS_FIELD_NUMBER
      See Also:
    • EXPLAIN_FIELD_NUMBER

      public static final int EXPLAIN_FIELD_NUMBER
      See Also:
    • FROM_FIELD_NUMBER

      public static final int FROM_FIELD_NUMBER
      See Also:
    • IGNORE_THROTTLED_FIELD_NUMBER

      public static final int IGNORE_THROTTLED_FIELD_NUMBER
      See Also:
    • IGNORE_UNAVAILABLE_FIELD_NUMBER

      public static final int IGNORE_UNAVAILABLE_FIELD_NUMBER
      See Also:
    • INCLUDE_NAMED_QUERIES_SCORE_FIELD_NUMBER

      public static final int INCLUDE_NAMED_QUERIES_SCORE_FIELD_NUMBER
      See Also:
    • LENIENT_FIELD_NUMBER

      public static final int LENIENT_FIELD_NUMBER
      See Also:
    • MAX_CONCURRENT_SHARD_REQUESTS_FIELD_NUMBER

      public static final int MAX_CONCURRENT_SHARD_REQUESTS_FIELD_NUMBER
      See Also:
    • PHASE_TOOK_FIELD_NUMBER

      public static final int PHASE_TOOK_FIELD_NUMBER
      See Also:
    • PRE_FILTER_SHARD_SIZE_FIELD_NUMBER

      public static final int PRE_FILTER_SHARD_SIZE_FIELD_NUMBER
      See Also:
    • PREFERENCE_FIELD_NUMBER

      public static final int PREFERENCE_FIELD_NUMBER
      See Also:
    • Q_FIELD_NUMBER

      public static final int Q_FIELD_NUMBER
      See Also:
    • REQUEST_CACHE_FIELD_NUMBER

      public static final int REQUEST_CACHE_FIELD_NUMBER
      See Also:
    • REST_TOTAL_HITS_AS_INT_FIELD_NUMBER

      public static final int REST_TOTAL_HITS_AS_INT_FIELD_NUMBER
      See Also:
    • ROUTING_FIELD_NUMBER

      public static final int ROUTING_FIELD_NUMBER
      See Also:
    • SCROLL_FIELD_NUMBER

      public static final int SCROLL_FIELD_NUMBER
      See Also:
    • SEARCH_PIPELINE_FIELD_NUMBER

      public static final int SEARCH_PIPELINE_FIELD_NUMBER
      See Also:
    • SEARCH_TYPE_FIELD_NUMBER

      public static final int SEARCH_TYPE_FIELD_NUMBER
      See Also:
    • SEQ_NO_PRIMARY_TERM_FIELD_NUMBER

      public static final int SEQ_NO_PRIMARY_TERM_FIELD_NUMBER
      See Also:
    • SIZE_FIELD_NUMBER

      public static final int SIZE_FIELD_NUMBER
      See Also:
    • STATS_FIELD_NUMBER

      public static final int STATS_FIELD_NUMBER
      See Also:
    • STORED_FIELDS_FIELD_NUMBER

      public static final int STORED_FIELDS_FIELD_NUMBER
      See Also:
    • SUGGEST_FIELD_FIELD_NUMBER

      public static final int SUGGEST_FIELD_FIELD_NUMBER
      See Also:
    • SUGGEST_MODE_FIELD_NUMBER

      public static final int SUGGEST_MODE_FIELD_NUMBER
      See Also:
    • SUGGEST_SIZE_FIELD_NUMBER

      public static final int SUGGEST_SIZE_FIELD_NUMBER
      See Also:
    • SUGGEST_TEXT_FIELD_NUMBER

      public static final int SUGGEST_TEXT_FIELD_NUMBER
      See Also:
    • TERMINATE_AFTER_FIELD_NUMBER

      public static final int TERMINATE_AFTER_FIELD_NUMBER
      See Also:
    • TIMEOUT_FIELD_NUMBER

      public static final int TIMEOUT_FIELD_NUMBER
      See Also:
    • TRACK_SCORES_FIELD_NUMBER

      public static final int TRACK_SCORES_FIELD_NUMBER
      See Also:
    • TRACK_TOTAL_HITS_FIELD_NUMBER

      public static final int TRACK_TOTAL_HITS_FIELD_NUMBER
      See Also:
    • TYPED_KEYS_FIELD_NUMBER

      public static final int TYPED_KEYS_FIELD_NUMBER
      See Also:
    • VERBOSE_PIPELINE_FIELD_NUMBER

      public static final int VERBOSE_PIPELINE_FIELD_NUMBER
      See Also:
    • VERSION_FIELD_NUMBER

      public static final int VERSION_FIELD_NUMBER
      See Also:
    • REQUEST_BODY_FIELD_NUMBER

      public static final int REQUEST_BODY_FIELD_NUMBER
      See Also:
    • GLOBAL_PARAMS_FIELD_NUMBER

      public static final int GLOBAL_PARAMS_FIELD_NUMBER
      See Also:
  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3
    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3
    • getIndexList

      public com.google.protobuf.ProtocolStringList getIndexList()
      repeated string index = 1 [json_name = "index"];
      Specified by:
      getIndexList in interface SearchRequestOrBuilder
      Returns:
      A list containing the index.
    • getIndexCount

      public int getIndexCount()
      repeated string index = 1 [json_name = "index"];
      Specified by:
      getIndexCount in interface SearchRequestOrBuilder
      Returns:
      The count of index.
    • getIndex

      public String getIndex(int index)
      repeated string index = 1 [json_name = "index"];
      Specified by:
      getIndex in interface SearchRequestOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The index at the given index.
    • getIndexBytes

      public com.google.protobuf.ByteString getIndexBytes(int index)
      repeated string index = 1 [json_name = "index"];
      Specified by:
      getIndexBytes in interface SearchRequestOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the index at the given index.
    • hasXSource

      public boolean hasXSource()
      optional .SourceConfigParam x_source = 2 [json_name = "xSource"];
      Specified by:
      hasXSource in interface SearchRequestOrBuilder
      Returns:
      Whether the xSource field is set.
    • getXSource

      public SourceConfigParam getXSource()
      optional .SourceConfigParam x_source = 2 [json_name = "xSource"];
      Specified by:
      getXSource in interface SearchRequestOrBuilder
      Returns:
      The xSource.
    • getXSourceOrBuilder

      public SourceConfigParamOrBuilder getXSourceOrBuilder()
      optional .SourceConfigParam x_source = 2 [json_name = "xSource"];
      Specified by:
      getXSourceOrBuilder in interface SearchRequestOrBuilder
    • getXSourceExcludesList

      public com.google.protobuf.ProtocolStringList getXSourceExcludesList()
      repeated string x_source_excludes = 3 [json_name = "xSourceExcludes"];
      Specified by:
      getXSourceExcludesList in interface SearchRequestOrBuilder
      Returns:
      A list containing the xSourceExcludes.
    • getXSourceExcludesCount

      public int getXSourceExcludesCount()
      repeated string x_source_excludes = 3 [json_name = "xSourceExcludes"];
      Specified by:
      getXSourceExcludesCount in interface SearchRequestOrBuilder
      Returns:
      The count of xSourceExcludes.
    • getXSourceExcludes

      public String getXSourceExcludes(int index)
      repeated string x_source_excludes = 3 [json_name = "xSourceExcludes"];
      Specified by:
      getXSourceExcludes in interface SearchRequestOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The xSourceExcludes at the given index.
    • getXSourceExcludesBytes

      public com.google.protobuf.ByteString getXSourceExcludesBytes(int index)
      repeated string x_source_excludes = 3 [json_name = "xSourceExcludes"];
      Specified by:
      getXSourceExcludesBytes in interface SearchRequestOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the xSourceExcludes at the given index.
    • getXSourceIncludesList

      public com.google.protobuf.ProtocolStringList getXSourceIncludesList()
      repeated string x_source_includes = 4 [json_name = "xSourceIncludes"];
      Specified by:
      getXSourceIncludesList in interface SearchRequestOrBuilder
      Returns:
      A list containing the xSourceIncludes.
    • getXSourceIncludesCount

      public int getXSourceIncludesCount()
      repeated string x_source_includes = 4 [json_name = "xSourceIncludes"];
      Specified by:
      getXSourceIncludesCount in interface SearchRequestOrBuilder
      Returns:
      The count of xSourceIncludes.
    • getXSourceIncludes

      public String getXSourceIncludes(int index)
      repeated string x_source_includes = 4 [json_name = "xSourceIncludes"];
      Specified by:
      getXSourceIncludes in interface SearchRequestOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The xSourceIncludes at the given index.
    • getXSourceIncludesBytes

      public com.google.protobuf.ByteString getXSourceIncludesBytes(int index)
      repeated string x_source_includes = 4 [json_name = "xSourceIncludes"];
      Specified by:
      getXSourceIncludesBytes in interface SearchRequestOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the xSourceIncludes at the given index.
    • hasAllowNoIndices

      public boolean hasAllowNoIndices()
      optional bool allow_no_indices = 5 [json_name = "allowNoIndices"];
      Specified by:
      hasAllowNoIndices in interface SearchRequestOrBuilder
      Returns:
      Whether the allowNoIndices field is set.
    • getAllowNoIndices

      public boolean getAllowNoIndices()
      optional bool allow_no_indices = 5 [json_name = "allowNoIndices"];
      Specified by:
      getAllowNoIndices in interface SearchRequestOrBuilder
      Returns:
      The allowNoIndices.
    • hasAllowPartialSearchResults

      public boolean hasAllowPartialSearchResults()
      optional bool allow_partial_search_results = 6 [json_name = "allowPartialSearchResults"];
      Specified by:
      hasAllowPartialSearchResults in interface SearchRequestOrBuilder
      Returns:
      Whether the allowPartialSearchResults field is set.
    • getAllowPartialSearchResults

      public boolean getAllowPartialSearchResults()
      optional bool allow_partial_search_results = 6 [json_name = "allowPartialSearchResults"];
      Specified by:
      getAllowPartialSearchResults in interface SearchRequestOrBuilder
      Returns:
      The allowPartialSearchResults.
    • hasAnalyzeWildcard

      public boolean hasAnalyzeWildcard()
      optional bool analyze_wildcard = 7 [json_name = "analyzeWildcard"];
      Specified by:
      hasAnalyzeWildcard in interface SearchRequestOrBuilder
      Returns:
      Whether the analyzeWildcard field is set.
    • getAnalyzeWildcard

      public boolean getAnalyzeWildcard()
      optional bool analyze_wildcard = 7 [json_name = "analyzeWildcard"];
      Specified by:
      getAnalyzeWildcard in interface SearchRequestOrBuilder
      Returns:
      The analyzeWildcard.
    • hasAnalyzer

      public boolean hasAnalyzer()
      optional string analyzer = 8 [json_name = "analyzer"];
      Specified by:
      hasAnalyzer in interface SearchRequestOrBuilder
      Returns:
      Whether the analyzer field is set.
    • getAnalyzer

      public String getAnalyzer()
      optional string analyzer = 8 [json_name = "analyzer"];
      Specified by:
      getAnalyzer in interface SearchRequestOrBuilder
      Returns:
      The analyzer.
    • getAnalyzerBytes

      public com.google.protobuf.ByteString getAnalyzerBytes()
      optional string analyzer = 8 [json_name = "analyzer"];
      Specified by:
      getAnalyzerBytes in interface SearchRequestOrBuilder
      Returns:
      The bytes for analyzer.
    • hasBatchedReduceSize

      public boolean hasBatchedReduceSize()
      optional int32 batched_reduce_size = 9 [json_name = "batchedReduceSize"];
      Specified by:
      hasBatchedReduceSize in interface SearchRequestOrBuilder
      Returns:
      Whether the batchedReduceSize field is set.
    • getBatchedReduceSize

      public int getBatchedReduceSize()
      optional int32 batched_reduce_size = 9 [json_name = "batchedReduceSize"];
      Specified by:
      getBatchedReduceSize in interface SearchRequestOrBuilder
      Returns:
      The batchedReduceSize.
    • hasCancelAfterTimeInterval

      public boolean hasCancelAfterTimeInterval()
      optional string cancel_after_time_interval = 10 [json_name = "cancelAfterTimeInterval"];
      Specified by:
      hasCancelAfterTimeInterval in interface SearchRequestOrBuilder
      Returns:
      Whether the cancelAfterTimeInterval field is set.
    • getCancelAfterTimeInterval

      public String getCancelAfterTimeInterval()
      optional string cancel_after_time_interval = 10 [json_name = "cancelAfterTimeInterval"];
      Specified by:
      getCancelAfterTimeInterval in interface SearchRequestOrBuilder
      Returns:
      The cancelAfterTimeInterval.
    • getCancelAfterTimeIntervalBytes

      public com.google.protobuf.ByteString getCancelAfterTimeIntervalBytes()
      optional string cancel_after_time_interval = 10 [json_name = "cancelAfterTimeInterval"];
      Specified by:
      getCancelAfterTimeIntervalBytes in interface SearchRequestOrBuilder
      Returns:
      The bytes for cancelAfterTimeInterval.
    • hasCcsMinimizeRoundtrips

      public boolean hasCcsMinimizeRoundtrips()
      optional bool ccs_minimize_roundtrips = 11 [json_name = "ccsMinimizeRoundtrips"];
      Specified by:
      hasCcsMinimizeRoundtrips in interface SearchRequestOrBuilder
      Returns:
      Whether the ccsMinimizeRoundtrips field is set.
    • getCcsMinimizeRoundtrips

      public boolean getCcsMinimizeRoundtrips()
      optional bool ccs_minimize_roundtrips = 11 [json_name = "ccsMinimizeRoundtrips"];
      Specified by:
      getCcsMinimizeRoundtrips in interface SearchRequestOrBuilder
      Returns:
      The ccsMinimizeRoundtrips.
    • hasDefaultOperator

      public boolean hasDefaultOperator()
      optional .Operator default_operator = 12 [json_name = "defaultOperator"];
      Specified by:
      hasDefaultOperator in interface SearchRequestOrBuilder
      Returns:
      Whether the defaultOperator field is set.
    • getDefaultOperatorValue

      public int getDefaultOperatorValue()
      optional .Operator default_operator = 12 [json_name = "defaultOperator"];
      Specified by:
      getDefaultOperatorValue in interface SearchRequestOrBuilder
      Returns:
      The enum numeric value on the wire for defaultOperator.
    • getDefaultOperator

      public Operator getDefaultOperator()
      optional .Operator default_operator = 12 [json_name = "defaultOperator"];
      Specified by:
      getDefaultOperator in interface SearchRequestOrBuilder
      Returns:
      The defaultOperator.
    • hasDf

      public boolean hasDf()
      optional string df = 13 [json_name = "df"];
      Specified by:
      hasDf in interface SearchRequestOrBuilder
      Returns:
      Whether the df field is set.
    • getDf

      public String getDf()
      optional string df = 13 [json_name = "df"];
      Specified by:
      getDf in interface SearchRequestOrBuilder
      Returns:
      The df.
    • getDfBytes

      public com.google.protobuf.ByteString getDfBytes()
      optional string df = 13 [json_name = "df"];
      Specified by:
      getDfBytes in interface SearchRequestOrBuilder
      Returns:
      The bytes for df.
    • getDocvalueFieldsList

      public com.google.protobuf.ProtocolStringList getDocvalueFieldsList()
      repeated string docvalue_fields = 14 [json_name = "docvalueFields"];
      Specified by:
      getDocvalueFieldsList in interface SearchRequestOrBuilder
      Returns:
      A list containing the docvalueFields.
    • getDocvalueFieldsCount

      public int getDocvalueFieldsCount()
      repeated string docvalue_fields = 14 [json_name = "docvalueFields"];
      Specified by:
      getDocvalueFieldsCount in interface SearchRequestOrBuilder
      Returns:
      The count of docvalueFields.
    • getDocvalueFields

      public String getDocvalueFields(int index)
      repeated string docvalue_fields = 14 [json_name = "docvalueFields"];
      Specified by:
      getDocvalueFields in interface SearchRequestOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The docvalueFields at the given index.
    • getDocvalueFieldsBytes

      public com.google.protobuf.ByteString getDocvalueFieldsBytes(int index)
      repeated string docvalue_fields = 14 [json_name = "docvalueFields"];
      Specified by:
      getDocvalueFieldsBytes in interface SearchRequestOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the docvalueFields at the given index.
    • getExpandWildcardsList

      public List<ExpandWildcard> getExpandWildcardsList()
      repeated .ExpandWildcard expand_wildcards = 15 [json_name = "expandWildcards"];
      Specified by:
      getExpandWildcardsList in interface SearchRequestOrBuilder
      Returns:
      A list containing the expandWildcards.
    • getExpandWildcardsCount

      public int getExpandWildcardsCount()
      repeated .ExpandWildcard expand_wildcards = 15 [json_name = "expandWildcards"];
      Specified by:
      getExpandWildcardsCount in interface SearchRequestOrBuilder
      Returns:
      The count of expandWildcards.
    • getExpandWildcards

      public ExpandWildcard getExpandWildcards(int index)
      repeated .ExpandWildcard expand_wildcards = 15 [json_name = "expandWildcards"];
      Specified by:
      getExpandWildcards in interface SearchRequestOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The expandWildcards at the given index.
    • getExpandWildcardsValueList

      public List<Integer> getExpandWildcardsValueList()
      repeated .ExpandWildcard expand_wildcards = 15 [json_name = "expandWildcards"];
      Specified by:
      getExpandWildcardsValueList in interface SearchRequestOrBuilder
      Returns:
      A list containing the enum numeric values on the wire for expandWildcards.
    • getExpandWildcardsValue

      public int getExpandWildcardsValue(int index)
      repeated .ExpandWildcard expand_wildcards = 15 [json_name = "expandWildcards"];
      Specified by:
      getExpandWildcardsValue in interface SearchRequestOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The enum numeric value on the wire of expandWildcards at the given index.
    • hasExplain

      public boolean hasExplain()
      optional bool explain = 16 [json_name = "explain"];
      Specified by:
      hasExplain in interface SearchRequestOrBuilder
      Returns:
      Whether the explain field is set.
    • getExplain

      public boolean getExplain()
      optional bool explain = 16 [json_name = "explain"];
      Specified by:
      getExplain in interface SearchRequestOrBuilder
      Returns:
      The explain.
    • hasFrom

      public boolean hasFrom()
      optional int32 from = 17 [json_name = "from"];
      Specified by:
      hasFrom in interface SearchRequestOrBuilder
      Returns:
      Whether the from field is set.
    • getFrom

      public int getFrom()
      optional int32 from = 17 [json_name = "from"];
      Specified by:
      getFrom in interface SearchRequestOrBuilder
      Returns:
      The from.
    • hasIgnoreThrottled

      public boolean hasIgnoreThrottled()
      optional bool ignore_throttled = 18 [json_name = "ignoreThrottled"];
      Specified by:
      hasIgnoreThrottled in interface SearchRequestOrBuilder
      Returns:
      Whether the ignoreThrottled field is set.
    • getIgnoreThrottled

      public boolean getIgnoreThrottled()
      optional bool ignore_throttled = 18 [json_name = "ignoreThrottled"];
      Specified by:
      getIgnoreThrottled in interface SearchRequestOrBuilder
      Returns:
      The ignoreThrottled.
    • hasIgnoreUnavailable

      public boolean hasIgnoreUnavailable()
      optional bool ignore_unavailable = 19 [json_name = "ignoreUnavailable"];
      Specified by:
      hasIgnoreUnavailable in interface SearchRequestOrBuilder
      Returns:
      Whether the ignoreUnavailable field is set.
    • getIgnoreUnavailable

      public boolean getIgnoreUnavailable()
      optional bool ignore_unavailable = 19 [json_name = "ignoreUnavailable"];
      Specified by:
      getIgnoreUnavailable in interface SearchRequestOrBuilder
      Returns:
      The ignoreUnavailable.
    • hasIncludeNamedQueriesScore

      public boolean hasIncludeNamedQueriesScore()
      optional bool include_named_queries_score = 20 [json_name = "includeNamedQueriesScore"];
      Specified by:
      hasIncludeNamedQueriesScore in interface SearchRequestOrBuilder
      Returns:
      Whether the includeNamedQueriesScore field is set.
    • getIncludeNamedQueriesScore

      public boolean getIncludeNamedQueriesScore()
      optional bool include_named_queries_score = 20 [json_name = "includeNamedQueriesScore"];
      Specified by:
      getIncludeNamedQueriesScore in interface SearchRequestOrBuilder
      Returns:
      The includeNamedQueriesScore.
    • hasLenient

      public boolean hasLenient()
      optional bool lenient = 21 [json_name = "lenient"];
      Specified by:
      hasLenient in interface SearchRequestOrBuilder
      Returns:
      Whether the lenient field is set.
    • getLenient

      public boolean getLenient()
      optional bool lenient = 21 [json_name = "lenient"];
      Specified by:
      getLenient in interface SearchRequestOrBuilder
      Returns:
      The lenient.
    • hasMaxConcurrentShardRequests

      public boolean hasMaxConcurrentShardRequests()
      optional int32 max_concurrent_shard_requests = 22 [json_name = "maxConcurrentShardRequests"];
      Specified by:
      hasMaxConcurrentShardRequests in interface SearchRequestOrBuilder
      Returns:
      Whether the maxConcurrentShardRequests field is set.
    • getMaxConcurrentShardRequests

      public int getMaxConcurrentShardRequests()
      optional int32 max_concurrent_shard_requests = 22 [json_name = "maxConcurrentShardRequests"];
      Specified by:
      getMaxConcurrentShardRequests in interface SearchRequestOrBuilder
      Returns:
      The maxConcurrentShardRequests.
    • hasPhaseTook

      public boolean hasPhaseTook()
      optional bool phase_took = 23 [json_name = "phaseTook"];
      Specified by:
      hasPhaseTook in interface SearchRequestOrBuilder
      Returns:
      Whether the phaseTook field is set.
    • getPhaseTook

      public boolean getPhaseTook()
      optional bool phase_took = 23 [json_name = "phaseTook"];
      Specified by:
      getPhaseTook in interface SearchRequestOrBuilder
      Returns:
      The phaseTook.
    • hasPreFilterShardSize

      public boolean hasPreFilterShardSize()
      optional int32 pre_filter_shard_size = 24 [json_name = "preFilterShardSize"];
      Specified by:
      hasPreFilterShardSize in interface SearchRequestOrBuilder
      Returns:
      Whether the preFilterShardSize field is set.
    • getPreFilterShardSize

      public int getPreFilterShardSize()
      optional int32 pre_filter_shard_size = 24 [json_name = "preFilterShardSize"];
      Specified by:
      getPreFilterShardSize in interface SearchRequestOrBuilder
      Returns:
      The preFilterShardSize.
    • hasPreference

      public boolean hasPreference()
      optional string preference = 25 [json_name = "preference"];
      Specified by:
      hasPreference in interface SearchRequestOrBuilder
      Returns:
      Whether the preference field is set.
    • getPreference

      public String getPreference()
      optional string preference = 25 [json_name = "preference"];
      Specified by:
      getPreference in interface SearchRequestOrBuilder
      Returns:
      The preference.
    • getPreferenceBytes

      public com.google.protobuf.ByteString getPreferenceBytes()
      optional string preference = 25 [json_name = "preference"];
      Specified by:
      getPreferenceBytes in interface SearchRequestOrBuilder
      Returns:
      The bytes for preference.
    • hasQ

      public boolean hasQ()
      optional string q = 26 [json_name = "q"];
      Specified by:
      hasQ in interface SearchRequestOrBuilder
      Returns:
      Whether the q field is set.
    • getQ

      public String getQ()
      optional string q = 26 [json_name = "q"];
      Specified by:
      getQ in interface SearchRequestOrBuilder
      Returns:
      The q.
    • getQBytes

      public com.google.protobuf.ByteString getQBytes()
      optional string q = 26 [json_name = "q"];
      Specified by:
      getQBytes in interface SearchRequestOrBuilder
      Returns:
      The bytes for q.
    • hasRequestCache

      public boolean hasRequestCache()
      optional bool request_cache = 27 [json_name = "requestCache"];
      Specified by:
      hasRequestCache in interface SearchRequestOrBuilder
      Returns:
      Whether the requestCache field is set.
    • getRequestCache

      public boolean getRequestCache()
      optional bool request_cache = 27 [json_name = "requestCache"];
      Specified by:
      getRequestCache in interface SearchRequestOrBuilder
      Returns:
      The requestCache.
    • hasRestTotalHitsAsInt

      public boolean hasRestTotalHitsAsInt()
      optional bool rest_total_hits_as_int = 28 [json_name = "restTotalHitsAsInt"];
      Specified by:
      hasRestTotalHitsAsInt in interface SearchRequestOrBuilder
      Returns:
      Whether the restTotalHitsAsInt field is set.
    • getRestTotalHitsAsInt

      public boolean getRestTotalHitsAsInt()
      optional bool rest_total_hits_as_int = 28 [json_name = "restTotalHitsAsInt"];
      Specified by:
      getRestTotalHitsAsInt in interface SearchRequestOrBuilder
      Returns:
      The restTotalHitsAsInt.
    • getRoutingList

      public com.google.protobuf.ProtocolStringList getRoutingList()
      repeated string routing = 29 [json_name = "routing"];
      Specified by:
      getRoutingList in interface SearchRequestOrBuilder
      Returns:
      A list containing the routing.
    • getRoutingCount

      public int getRoutingCount()
      repeated string routing = 29 [json_name = "routing"];
      Specified by:
      getRoutingCount in interface SearchRequestOrBuilder
      Returns:
      The count of routing.
    • getRouting

      public String getRouting(int index)
      repeated string routing = 29 [json_name = "routing"];
      Specified by:
      getRouting in interface SearchRequestOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The routing at the given index.
    • getRoutingBytes

      public com.google.protobuf.ByteString getRoutingBytes(int index)
      repeated string routing = 29 [json_name = "routing"];
      Specified by:
      getRoutingBytes in interface SearchRequestOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the routing at the given index.
    • hasScroll

      public boolean hasScroll()
      optional string scroll = 30 [json_name = "scroll"];
      Specified by:
      hasScroll in interface SearchRequestOrBuilder
      Returns:
      Whether the scroll field is set.
    • getScroll

      public String getScroll()
      optional string scroll = 30 [json_name = "scroll"];
      Specified by:
      getScroll in interface SearchRequestOrBuilder
      Returns:
      The scroll.
    • getScrollBytes

      public com.google.protobuf.ByteString getScrollBytes()
      optional string scroll = 30 [json_name = "scroll"];
      Specified by:
      getScrollBytes in interface SearchRequestOrBuilder
      Returns:
      The bytes for scroll.
    • hasSearchPipeline

      public boolean hasSearchPipeline()
      optional string search_pipeline = 31 [json_name = "searchPipeline"];
      Specified by:
      hasSearchPipeline in interface SearchRequestOrBuilder
      Returns:
      Whether the searchPipeline field is set.
    • getSearchPipeline

      public String getSearchPipeline()
      optional string search_pipeline = 31 [json_name = "searchPipeline"];
      Specified by:
      getSearchPipeline in interface SearchRequestOrBuilder
      Returns:
      The searchPipeline.
    • getSearchPipelineBytes

      public com.google.protobuf.ByteString getSearchPipelineBytes()
      optional string search_pipeline = 31 [json_name = "searchPipeline"];
      Specified by:
      getSearchPipelineBytes in interface SearchRequestOrBuilder
      Returns:
      The bytes for searchPipeline.
    • hasSearchType

      public boolean hasSearchType()
      optional .SearchType search_type = 32 [json_name = "searchType"];
      Specified by:
      hasSearchType in interface SearchRequestOrBuilder
      Returns:
      Whether the searchType field is set.
    • getSearchTypeValue

      public int getSearchTypeValue()
      optional .SearchType search_type = 32 [json_name = "searchType"];
      Specified by:
      getSearchTypeValue in interface SearchRequestOrBuilder
      Returns:
      The enum numeric value on the wire for searchType.
    • getSearchType

      public SearchType getSearchType()
      optional .SearchType search_type = 32 [json_name = "searchType"];
      Specified by:
      getSearchType in interface SearchRequestOrBuilder
      Returns:
      The searchType.
    • hasSeqNoPrimaryTerm

      public boolean hasSeqNoPrimaryTerm()
      optional bool seq_no_primary_term = 33 [json_name = "seqNoPrimaryTerm"];
      Specified by:
      hasSeqNoPrimaryTerm in interface SearchRequestOrBuilder
      Returns:
      Whether the seqNoPrimaryTerm field is set.
    • getSeqNoPrimaryTerm

      public boolean getSeqNoPrimaryTerm()
      optional bool seq_no_primary_term = 33 [json_name = "seqNoPrimaryTerm"];
      Specified by:
      getSeqNoPrimaryTerm in interface SearchRequestOrBuilder
      Returns:
      The seqNoPrimaryTerm.
    • hasSize

      public boolean hasSize()
      optional int32 size = 34 [json_name = "size"];
      Specified by:
      hasSize in interface SearchRequestOrBuilder
      Returns:
      Whether the size field is set.
    • getSize

      public int getSize()
      optional int32 size = 34 [json_name = "size"];
      Specified by:
      getSize in interface SearchRequestOrBuilder
      Returns:
      The size.
    • getStatsList

      public com.google.protobuf.ProtocolStringList getStatsList()
      repeated string stats = 35 [json_name = "stats"];
      Specified by:
      getStatsList in interface SearchRequestOrBuilder
      Returns:
      A list containing the stats.
    • getStatsCount

      public int getStatsCount()
      repeated string stats = 35 [json_name = "stats"];
      Specified by:
      getStatsCount in interface SearchRequestOrBuilder
      Returns:
      The count of stats.
    • getStats

      public String getStats(int index)
      repeated string stats = 35 [json_name = "stats"];
      Specified by:
      getStats in interface SearchRequestOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The stats at the given index.
    • getStatsBytes

      public com.google.protobuf.ByteString getStatsBytes(int index)
      repeated string stats = 35 [json_name = "stats"];
      Specified by:
      getStatsBytes in interface SearchRequestOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the stats at the given index.
    • getStoredFieldsList

      public com.google.protobuf.ProtocolStringList getStoredFieldsList()
      repeated string stored_fields = 36 [json_name = "storedFields"];
      Specified by:
      getStoredFieldsList in interface SearchRequestOrBuilder
      Returns:
      A list containing the storedFields.
    • getStoredFieldsCount

      public int getStoredFieldsCount()
      repeated string stored_fields = 36 [json_name = "storedFields"];
      Specified by:
      getStoredFieldsCount in interface SearchRequestOrBuilder
      Returns:
      The count of storedFields.
    • getStoredFields

      public String getStoredFields(int index)
      repeated string stored_fields = 36 [json_name = "storedFields"];
      Specified by:
      getStoredFields in interface SearchRequestOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The storedFields at the given index.
    • getStoredFieldsBytes

      public com.google.protobuf.ByteString getStoredFieldsBytes(int index)
      repeated string stored_fields = 36 [json_name = "storedFields"];
      Specified by:
      getStoredFieldsBytes in interface SearchRequestOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the storedFields at the given index.
    • hasSuggestField

      public boolean hasSuggestField()
      optional string suggest_field = 37 [json_name = "suggestField"];
      Specified by:
      hasSuggestField in interface SearchRequestOrBuilder
      Returns:
      Whether the suggestField field is set.
    • getSuggestField

      public String getSuggestField()
      optional string suggest_field = 37 [json_name = "suggestField"];
      Specified by:
      getSuggestField in interface SearchRequestOrBuilder
      Returns:
      The suggestField.
    • getSuggestFieldBytes

      public com.google.protobuf.ByteString getSuggestFieldBytes()
      optional string suggest_field = 37 [json_name = "suggestField"];
      Specified by:
      getSuggestFieldBytes in interface SearchRequestOrBuilder
      Returns:
      The bytes for suggestField.
    • hasSuggestMode

      public boolean hasSuggestMode()
      optional .SuggestMode suggest_mode = 38 [json_name = "suggestMode"];
      Specified by:
      hasSuggestMode in interface SearchRequestOrBuilder
      Returns:
      Whether the suggestMode field is set.
    • getSuggestModeValue

      public int getSuggestModeValue()
      optional .SuggestMode suggest_mode = 38 [json_name = "suggestMode"];
      Specified by:
      getSuggestModeValue in interface SearchRequestOrBuilder
      Returns:
      The enum numeric value on the wire for suggestMode.
    • getSuggestMode

      public SuggestMode getSuggestMode()
      optional .SuggestMode suggest_mode = 38 [json_name = "suggestMode"];
      Specified by:
      getSuggestMode in interface SearchRequestOrBuilder
      Returns:
      The suggestMode.
    • hasSuggestSize

      public boolean hasSuggestSize()
      optional int32 suggest_size = 39 [json_name = "suggestSize"];
      Specified by:
      hasSuggestSize in interface SearchRequestOrBuilder
      Returns:
      Whether the suggestSize field is set.
    • getSuggestSize

      public int getSuggestSize()
      optional int32 suggest_size = 39 [json_name = "suggestSize"];
      Specified by:
      getSuggestSize in interface SearchRequestOrBuilder
      Returns:
      The suggestSize.
    • hasSuggestText

      public boolean hasSuggestText()
      optional string suggest_text = 40 [json_name = "suggestText"];
      Specified by:
      hasSuggestText in interface SearchRequestOrBuilder
      Returns:
      Whether the suggestText field is set.
    • getSuggestText

      public String getSuggestText()
      optional string suggest_text = 40 [json_name = "suggestText"];
      Specified by:
      getSuggestText in interface SearchRequestOrBuilder
      Returns:
      The suggestText.
    • getSuggestTextBytes

      public com.google.protobuf.ByteString getSuggestTextBytes()
      optional string suggest_text = 40 [json_name = "suggestText"];
      Specified by:
      getSuggestTextBytes in interface SearchRequestOrBuilder
      Returns:
      The bytes for suggestText.
    • hasTerminateAfter

      public boolean hasTerminateAfter()
      optional int32 terminate_after = 41 [json_name = "terminateAfter"];
      Specified by:
      hasTerminateAfter in interface SearchRequestOrBuilder
      Returns:
      Whether the terminateAfter field is set.
    • getTerminateAfter

      public int getTerminateAfter()
      optional int32 terminate_after = 41 [json_name = "terminateAfter"];
      Specified by:
      getTerminateAfter in interface SearchRequestOrBuilder
      Returns:
      The terminateAfter.
    • hasTimeout

      public boolean hasTimeout()
      optional string timeout = 42 [json_name = "timeout"];
      Specified by:
      hasTimeout in interface SearchRequestOrBuilder
      Returns:
      Whether the timeout field is set.
    • getTimeout

      public String getTimeout()
      optional string timeout = 42 [json_name = "timeout"];
      Specified by:
      getTimeout in interface SearchRequestOrBuilder
      Returns:
      The timeout.
    • getTimeoutBytes

      public com.google.protobuf.ByteString getTimeoutBytes()
      optional string timeout = 42 [json_name = "timeout"];
      Specified by:
      getTimeoutBytes in interface SearchRequestOrBuilder
      Returns:
      The bytes for timeout.
    • hasTrackScores

      public boolean hasTrackScores()
      optional bool track_scores = 43 [json_name = "trackScores"];
      Specified by:
      hasTrackScores in interface SearchRequestOrBuilder
      Returns:
      Whether the trackScores field is set.
    • getTrackScores

      public boolean getTrackScores()
      optional bool track_scores = 43 [json_name = "trackScores"];
      Specified by:
      getTrackScores in interface SearchRequestOrBuilder
      Returns:
      The trackScores.
    • hasTrackTotalHits

      public boolean hasTrackTotalHits()
      optional .TrackHits track_total_hits = 44 [json_name = "trackTotalHits"];
      Specified by:
      hasTrackTotalHits in interface SearchRequestOrBuilder
      Returns:
      Whether the trackTotalHits field is set.
    • getTrackTotalHits

      public TrackHits getTrackTotalHits()
      optional .TrackHits track_total_hits = 44 [json_name = "trackTotalHits"];
      Specified by:
      getTrackTotalHits in interface SearchRequestOrBuilder
      Returns:
      The trackTotalHits.
    • getTrackTotalHitsOrBuilder

      public TrackHitsOrBuilder getTrackTotalHitsOrBuilder()
      optional .TrackHits track_total_hits = 44 [json_name = "trackTotalHits"];
      Specified by:
      getTrackTotalHitsOrBuilder in interface SearchRequestOrBuilder
    • hasTypedKeys

      public boolean hasTypedKeys()
      optional bool typed_keys = 45 [json_name = "typedKeys"];
      Specified by:
      hasTypedKeys in interface SearchRequestOrBuilder
      Returns:
      Whether the typedKeys field is set.
    • getTypedKeys

      public boolean getTypedKeys()
      optional bool typed_keys = 45 [json_name = "typedKeys"];
      Specified by:
      getTypedKeys in interface SearchRequestOrBuilder
      Returns:
      The typedKeys.
    • hasVerbosePipeline

      public boolean hasVerbosePipeline()
      optional bool verbose_pipeline = 46 [json_name = "verbosePipeline"];
      Specified by:
      hasVerbosePipeline in interface SearchRequestOrBuilder
      Returns:
      Whether the verbosePipeline field is set.
    • getVerbosePipeline

      public boolean getVerbosePipeline()
      optional bool verbose_pipeline = 46 [json_name = "verbosePipeline"];
      Specified by:
      getVerbosePipeline in interface SearchRequestOrBuilder
      Returns:
      The verbosePipeline.
    • hasVersion

      public boolean hasVersion()
      optional bool version = 47 [json_name = "version"];
      Specified by:
      hasVersion in interface SearchRequestOrBuilder
      Returns:
      Whether the version field is set.
    • getVersion

      public boolean getVersion()
      optional bool version = 47 [json_name = "version"];
      Specified by:
      getVersion in interface SearchRequestOrBuilder
      Returns:
      The version.
    • hasRequestBody

      public boolean hasRequestBody()
      .SearchRequestBody request_body = 48 [json_name = "requestBody"];
      Specified by:
      hasRequestBody in interface SearchRequestOrBuilder
      Returns:
      Whether the requestBody field is set.
    • getRequestBody

      public SearchRequestBody getRequestBody()
      .SearchRequestBody request_body = 48 [json_name = "requestBody"];
      Specified by:
      getRequestBody in interface SearchRequestOrBuilder
      Returns:
      The requestBody.
    • getRequestBodyOrBuilder

      public SearchRequestBodyOrBuilder getRequestBodyOrBuilder()
      .SearchRequestBody request_body = 48 [json_name = "requestBody"];
      Specified by:
      getRequestBodyOrBuilder in interface SearchRequestOrBuilder
    • hasGlobalParams

      public boolean hasGlobalParams()
      optional .GlobalParams global_params = 49 [json_name = "globalParams"];
      Specified by:
      hasGlobalParams in interface SearchRequestOrBuilder
      Returns:
      Whether the globalParams field is set.
    • getGlobalParams

      public GlobalParams getGlobalParams()
      optional .GlobalParams global_params = 49 [json_name = "globalParams"];
      Specified by:
      getGlobalParams in interface SearchRequestOrBuilder
      Returns:
      The globalParams.
    • getGlobalParamsOrBuilder

      public GlobalParamsOrBuilder getGlobalParamsOrBuilder()
      optional .GlobalParams global_params = 49 [json_name = "globalParams"];
      Specified by:
      getGlobalParamsOrBuilder in interface SearchRequestOrBuilder
    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3
    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException
    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3
    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage
    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage
    • parseFrom

      public static SearchRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static SearchRequest parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static SearchRequest parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static SearchRequest parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static SearchRequest parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static SearchRequest parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static SearchRequest parseFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

      public static SearchRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

      public static SearchRequest parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

      public static SearchRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • parseFrom

      public static SearchRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

      public static SearchRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • newBuilderForType

      public SearchRequest.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite
    • newBuilder

      public static SearchRequest.Builder newBuilder()
    • newBuilder

      public static SearchRequest.Builder newBuilder(SearchRequest prototype)
    • toBuilder

      public SearchRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite
    • newBuilderForType

      protected SearchRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3
    • getDefaultInstance

      public static SearchRequest getDefaultInstance()
    • parser

      public static com.google.protobuf.Parser<SearchRequest> parser()
    • getParserForType

      public com.google.protobuf.Parser<SearchRequest> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3
    • getDefaultInstanceForType

      public SearchRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder