Package org.opensearch.client.opensearch._global

Class SearchRequest

java.lang.Object
org.opensearch.client.opensearch._types.RequestBase
org.opensearch.client.opensearch._global.SearchRequest
All Implemented Interfaces:
ToJsonp
public final class SearchRequest
extends RequestBase
implements ToJsonp

  • Field Details

  • Constructor Details

  • Method Details

    • index

      @Nullable public java.util.List<java.lang.String> index()
      API name: index

    • type

      @Nullable public java.util.List<java.lang.String> type()
      API name: type

    • allowNoIndices

      @Nullable public java.lang.Boolean allowNoIndices()
      API name: allow_no_indices

    • allowPartialSearchResults

      @Nullable public java.lang.Boolean allowPartialSearchResults()
      API name: allow_partial_search_results

    • analyzer

      @Nullable public java.lang.String analyzer()
      API name: analyzer

    • analyzeWildcard

      @Nullable public java.lang.Boolean analyzeWildcard()
      API name: analyze_wildcard

    • batchedReduceSize

      @Nullable public java.lang.Number batchedReduceSize()
      API name: batched_reduce_size

    • ccsMinimizeRoundtrips

      @Nullable public java.lang.Boolean ccsMinimizeRoundtrips()
      API name: ccs_minimize_roundtrips

    • defaultOperator

      @Nullable public jakarta.json.JsonValue defaultOperator()
      API name: default_operator

    • df

      @Nullable public java.lang.String df()
      API name: df

    • expandWildcards

      @Nullable public jakarta.json.JsonValue expandWildcards()
      API name: expand_wildcards

    • ignoreThrottled

      @Nullable public java.lang.Boolean ignoreThrottled()
      API name: ignore_throttled

    • ignoreUnavailable

      @Nullable public java.lang.Boolean ignoreUnavailable()
      API name: ignore_unavailable

    • lenient

      @Nullable public java.lang.Boolean lenient()
      API name: lenient

    • maxConcurrentShardRequests

      @Nullable public java.lang.Number maxConcurrentShardRequests()
      API name: max_concurrent_shard_requests

    • minCompatibleShardNode

      @Nullable public java.lang.String minCompatibleShardNode()
      API name: min_compatible_shard_node

    • preference

      @Nullable public java.lang.String preference()
      API name: preference

    • preFilterShardSize

      @Nullable public java.lang.Number preFilterShardSize()
      API name: pre_filter_shard_size

    • requestCache

      @Nullable public java.lang.Boolean requestCache()
      API name: request_cache

    • routing

      @Nullable public jakarta.json.JsonValue routing()
      API name: routing

    • scroll

      @Nullable public jakarta.json.JsonValue scroll()
      API name: scroll

    • searchType

      @Nullable public jakarta.json.JsonValue searchType()
      API name: search_type

    • suggestField

      @Nullable public java.lang.String suggestField()
      API name: suggest_field

    • suggestMode

      @Nullable public jakarta.json.JsonValue suggestMode()
      API name: suggest_mode

    • suggestSize

      @Nullable public java.lang.Number suggestSize()
      API name: suggest_size

    • suggestText

      @Nullable public java.lang.String suggestText()
      API name: suggest_text

    • typedKeys

      @Nullable public java.lang.Boolean typedKeys()
      API name: typed_keys

    • restTotalHitsAsInt

      @Nullable public java.lang.Boolean restTotalHitsAsInt()
      API name: rest_total_hits_as_int

    • sourceExcludes

      @Nullable public java.util.List<java.lang.String> sourceExcludes()
      API name: _source_excludes

    • sourceIncludes

      @Nullable public java.util.List<java.lang.String> sourceIncludes()
      API name: _source_includes

    • q

      @Nullable public java.lang.String q()
      API name: q

    • aggs

      @Nullable public java.util.Map<java.lang.String,​AggregationContainer> aggs()
      API name: aggs

    • aggregations

      @Nullable public java.util.Map<java.lang.String,​AggregationContainer> aggregations()
      API name: aggregations

    • collapse

      @Nullable public FieldCollapse collapse()
      API name: collapse

    • explain

      @Nullable public java.lang.Boolean explain()
      API name: explain

    • from

      @Nullable public java.lang.Number from()
      API name: from

    • highlight

      @Nullable public Highlight highlight()
      API name: highlight

    • trackTotalHits

      @Nullable public jakarta.json.JsonValue trackTotalHits()
      API name: track_total_hits

    • indicesBoost

      @Nullable public java.util.List<java.util.Map<java.lang.String,​java.lang.Number>> indicesBoost()
      API name: indices_boost

    • docvalueFields

      @Nullable public jakarta.json.JsonValue docvalueFields()
      API name: docvalue_fields

    • minScore

      @Nullable public java.lang.Number minScore()
      API name: min_score

    • postFilter

      @Nullable public QueryContainer postFilter()
      API name: post_filter

    • profile

      @Nullable public java.lang.Boolean profile()
      API name: profile

    • query

      @Nullable public QueryContainer query()
      API name: query

    • rescore

      @Nullable public java.util.List<Rescore> rescore()
      API name: rescore

    • scriptFields

      @Nullable public java.util.Map<java.lang.String,​ScriptField> scriptFields()
      API name: script_fields

    • searchAfter

      @Nullable public java.util.List<jakarta.json.JsonValue> searchAfter()
      API name: search_after

    • size

      @Nullable public java.lang.Number size()
      API name: size

    • slice

      @Nullable public SlicedScroll slice()
      API name: slice

    • sort

      @Nullable public java.util.List<jakarta.json.JsonValue> sort()
      API name: sort

    • source

      @Nullable public jakarta.json.JsonValue source()
      API name: _source

    • fields

      @Nullable public java.util.List<jakarta.json.JsonValue> fields()
      API name: fields

    • suggest

      @Nullable public jakarta.json.JsonValue suggest()
      API name: suggest

    • terminateAfter

      @Nullable public java.lang.Number terminateAfter()
      API name: terminate_after

    • timeout

      @Nullable public java.lang.String timeout()
      API name: timeout

    • trackScores

      @Nullable public java.lang.Boolean trackScores()
      API name: track_scores

    • version

      @Nullable public java.lang.Boolean version()
      API name: version

    • seqNoPrimaryTerm

      @Nullable public java.lang.Boolean seqNoPrimaryTerm()
      API name: seq_no_primary_term

    • storedFields

      @Nullable public java.util.List<java.lang.String> storedFields()
      API name: stored_fields

    • pit

      @Nullable public PointInTimeReference pit()
      API name: pit

    • runtimeMappings

      @Nullable public java.util.Map<java.lang.String,​RuntimeField> runtimeMappings()
      API name: runtime_mappings

    • stats

      @Nullable public java.util.List<java.lang.String> stats()
      API name: stats

    • toJsonp

      public void toJsonp​(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
      Serialize this object to JSON.
      Specified by:
      toJsonp in interface ToJsonp

    • toJsonpInternal

      protected void toJsonpInternal​(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)

    • setupSearchRequestDeserializer

      protected static void setupSearchRequestDeserializer​(DelegatingDeserializer<SearchRequest.Builder> op)

    • createSearchEndpoint

      public static <TDocument> Endpoint<SearchRequest,​SearchResponse<TDocument>,​OpenSearchError> createSearchEndpoint​(JsonpDeserializer<TDocument> tDocumentDeserializer)
      Create an "search" endpoint.