Package org.opensearch.client.opensearch.knn

Class SearchModelsRequest

java.lang.Object
org.opensearch.client.opensearch._types.RequestBase
org.opensearch.client.opensearch.knn.SearchModelsRequest
All Implemented Interfaces:
ToCopyableBuilder<SearchModelsRequest.Builder,SearchModelsRequest>
@Generated("org.opensearch.client.codegen.CodeGenerator") public final class SearchModelsRequest extends RequestBase implements ToCopyableBuilder<SearchModelsRequest.Builder,SearchModelsRequest>
Use an OpenSearch query to search for models in the index.

  • Field Details

  • Method Details

    • of

      public static SearchModelsRequest of(Function<SearchModelsRequest.Builder,ObjectBuilder<SearchModelsRequest>> fn)

    • allowNoIndices

      @Nullable public final Boolean allowNoIndices()
      Whether to ignore if a wildcard indexes expression resolves into no concrete indexes. (This includes _all string or when no indexes have been specified).

      API name: allow_no_indices

    • allowPartialSearchResults

      @Nullable public final Boolean allowPartialSearchResults()
      Indicate if an error should be returned if there is a partial search failure or timeout.

      API name: allow_partial_search_results

    • analyzeWildcard

      @Nullable public final Boolean analyzeWildcard()
      Specify whether wildcard and prefix queries should be analyzed.

      API name: analyze_wildcard

    • analyzer

      @Nullable public final String analyzer()
      The analyzer to use for the query string.

      API name: analyzer

    • batchedReduceSize

      @Nullable public final Integer batchedReduceSize()
      The number of shard results that should be reduced at once on the coordinating node. This value should be used as a protection mechanism to reduce the memory overhead per search request if the potential number of shards in the request can be large.

      API name: batched_reduce_size

    • ccsMinimizeRoundtrips

      @Nullable public final Boolean ccsMinimizeRoundtrips()
      Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution.

      API name: ccs_minimize_roundtrips

    • defaultOperator

      @Nullable public final Operator defaultOperator()
      The default operator for query string query (AND or OR).

      API name: default_operator

    • df

      @Nullable public final String df()
      The field to use as default where no field prefix is given in the query string.

      API name: df

    • docvalueFields

      @Nonnull public final List<String> docvalueFields()
      A comma-separated list of fields to return as the docvalue representation of a field for each hit.

      API name: docvalue_fields

    • expandWildcards

      @Nonnull public final List<ExpandWildcard> expandWildcards()
      Whether to expand wildcard expression to concrete indexes that are open, closed or both.

      API name: expand_wildcards

    • explain

      @Nullable public final Boolean explain()
      Specify whether to return detailed information about score computation as part of a hit.

      API name: explain

    • from

      @Nullable public final Integer from()
      Starting offset.

      API name: from

    • ignoreThrottled

      @Nullable public final Boolean ignoreThrottled()
      Whether specified concrete, expanded or aliased indexes should be ignored when throttled.

      API name: ignore_throttled

    • ignoreUnavailable

      @Nullable public final Boolean ignoreUnavailable()
      Whether specified concrete indexes should be ignored when unavailable (missing or closed).

      API name: ignore_unavailable

    • lenient

      @Nullable public final Boolean lenient()
      Specify whether format-based query failures (such as providing text to a numeric field) should be ignored.

      API name: lenient

    • maxConcurrentShardRequests

      @Nullable public final Integer maxConcurrentShardRequests()
      The number of concurrent shard requests per node this search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests.

      API name: max_concurrent_shard_requests

    • preFilterShardSize

      @Nullable public final Integer preFilterShardSize()
      Threshold that enforces a pre-filter round-trip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter round-trip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method, that is if date filters are mandatory to match but the shard bounds and the query are disjoint.

      API name: pre_filter_shard_size

    • preference

      @Nullable public final String preference()
      Specify the node or shard the operation should be performed on.

      API name: preference

    • q

      @Nullable public final String q()
      Query in the Lucene query string syntax.

      API name: q

    • requestCache

      @Nullable public final Boolean requestCache()
      Specify if request cache should be used for this request or not, defaults to index level setting.

      API name: request_cache

    • restTotalHitsAsInt

      @Nullable public final Boolean restTotalHitsAsInt()
      Indicates whether hits.total should be rendered as an integer or an object in the rest search response.

      API name: rest_total_hits_as_int

    • routing

      @Nonnull public final List<String> routing()
      A comma-separated list of specific routing values.

      API name: routing

    • scroll

      @Nullable public final Time scroll()
      Specify how long a consistent view of the index should be maintained for scrolled search.

      API name: scroll

    • searchType

      @Nullable public final SearchType searchType()
      Search operation type.

      API name: search_type

    • seqNoPrimaryTerm

      @Nullable public final Boolean seqNoPrimaryTerm()
      Specify whether to return sequence number and primary term of the last modification of each hit.

      API name: seq_no_primary_term

    • size

      @Nullable public final Integer size()
      Number of hits to return.

      API name: size

    • sort

      @Nonnull public final List<String> sort()
      A comma-separated list of <field>:<direction> pairs.

      API name: sort

    • source

      @Nonnull public final List<String> source()
      Set to true or false to return the _source field or not, or a list of fields to return.

      API name: _source

    • sourceExcludes

      @Nonnull public final List<String> sourceExcludes()
      List of fields to exclude from the returned _source field.

      API name: _source_excludes

    • sourceIncludes

      @Nonnull public final List<String> sourceIncludes()
      List of fields to extract and return from the _source field.

      API name: _source_includes

    • stats

      @Nonnull public final List<String> stats()
      Specific 'tag' of the request for logging and statistical purposes.

      API name: stats

    • storedFields

      @Nonnull public final List<String> storedFields()
      A comma-separated list of stored fields to return.

      API name: stored_fields

    • suggestField

      @Nullable public final String suggestField()
      Specify which field to use for suggestions.

      API name: suggest_field

    • suggestMode

      @Nullable public final SuggestMode suggestMode()
      Specify suggest mode.

      API name: suggest_mode

    • suggestSize

      @Nullable public final Integer suggestSize()
      How many suggestions to return in response.

      API name: suggest_size

    • suggestText

      @Nullable public final String suggestText()
      The source text for which the suggestions should be returned.

      API name: suggest_text

    • terminateAfter

      @Nullable public final Integer terminateAfter()
      The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.

      API name: terminate_after

    • timeout

      @Nullable public final Time timeout()
      Operation timeout.

      API name: timeout

    • trackScores

      @Nullable public final Boolean trackScores()
      Whether to calculate and return scores even if they are not used for sorting.

      API name: track_scores

    • trackTotalHits

      @Nullable public final Boolean trackTotalHits()
      Indicate if the number of documents that match the query should be tracked.

      API name: track_total_hits

    • version

      @Nullable public final Boolean version()
      Whether to return document version as part of a hit.

      API name: version

    • toBuilder

      @Nonnull public SearchModelsRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Create a new builder ToCopyableBuilder that is initialised with the current state of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<SearchModelsRequest.Builder,SearchModelsRequest>
      Returns:
      a new builder instance.

    • builder

      @Nonnull public static SearchModelsRequest.Builder builder()

    • applyQueryParameters

      protected void applyQueryParameters(@Nonnull Map<String,String> params)
      Overrides:
      applyQueryParameters in class RequestBase

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object