Search Results for

    Show / Hide Table of Contents

    Class MultiSearchRequestParameters

    Request options for MultiSearch

    https://opensearch.org/docs/latest/api-reference/multi-search/

    Inheritance
    object
    RequestParameters<MultiSearchRequestParameters>
    MultiSearchRequestParameters
    Implements
    IRequestParameters
    Inherited Members
    RequestParameters<MultiSearchRequestParameters>.CustomResponseBuilder
    RequestParameters<MultiSearchRequestParameters>.QueryString
    RequestParameters<MultiSearchRequestParameters>.RequestConfiguration
    RequestParameters<MultiSearchRequestParameters>.ContainsQueryString(string)
    RequestParameters<MultiSearchRequestParameters>.GetQueryStringValue<TOut>(string)
    RequestParameters<MultiSearchRequestParameters>.GetResolvedQueryStringValue(string, IConnectionConfigurationValues)
    RequestParameters<MultiSearchRequestParameters>.SetQueryString(string, object)
    RequestParameters<MultiSearchRequestParameters>.Q<TOut>(string)
    RequestParameters<MultiSearchRequestParameters>.Q(string, object)
    RequestParameters<MultiSearchRequestParameters>.SetAcceptHeader(string)
    RequestParameters<MultiSearchRequestParameters>.AcceptHeaderFromFormat(string)
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: OpenSearch.Net
    Assembly: OpenSearch.Net.dll
    Syntax
    public class MultiSearchRequestParameters : RequestParameters<MultiSearchRequestParameters>, IRequestParameters

    Properties

    | Edit this page View Source

    CcsMinimizeRoundtrips

    If true, network round-trips between the coordinating node and remote clusters are minimized for cross-cluster search requests.

    Declaration
    public bool? CcsMinimizeRoundtrips { get; set; }
    Property Value
    Type Description
    bool?
    | Edit this page View Source

    DefaultHttpMethod

    Declaration
    public override HttpMethod DefaultHttpMethod { get; }
    Property Value
    Type Description
    HttpMethod
    Overrides
    RequestParameters<MultiSearchRequestParameters>.DefaultHttpMethod
    | Edit this page View Source

    MaxConcurrentSearches

    Maximum number of concurrent searches the multi search API can execute.

    Declaration
    public int? MaxConcurrentSearches { get; set; }
    Property Value
    Type Description
    int?
    | Edit this page View Source

    MaxConcurrentShardRequests

    Maximum number of concurrent shard requests that each sub-search request executes per node.

    Declaration
    public int? MaxConcurrentShardRequests { get; set; }
    Property Value
    Type Description
    int?
    | Edit this page View Source

    PreFilterShardSize

    Defines a threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method i.e., if date filters are mandatory to match but the shard bounds and the query are disjoint.

    Declaration
    public int? PreFilterShardSize { get; set; }
    Property Value
    Type Description
    int?
    | Edit this page View Source

    SearchType

    Indicates whether global term and document frequencies should be used when scoring returned documents.

    Declaration
    public SearchType? SearchType { get; set; }
    Property Value
    Type Description
    SearchType?
    | Edit this page View Source

    SupportsBody

    Declaration
    public override bool SupportsBody { get; }
    Property Value
    Type Description
    bool
    Overrides
    RequestParameters<MultiSearchRequestParameters>.SupportsBody
    | Edit this page View Source

    TotalHitsAsInteger

    If true, hits.total are returned as an integer in the response. Defaults to false, which returns an object.

    Declaration
    public bool? TotalHitsAsInteger { get; set; }
    Property Value
    Type Description
    bool?
    | Edit this page View Source

    TypedKeys

    Specifies whether aggregation and suggester names should be prefixed by their respective types in the response.

    Declaration
    public bool? TypedKeys { get; set; }
    Property Value
    Type Description
    bool?

    Implements

    IRequestParameters

    Extension Methods

    SuffixExtensions.Suffix(object, string)
    • Edit this page
    • View Source
    In this article
    • Properties
      • CcsMinimizeRoundtrips
      • DefaultHttpMethod
      • MaxConcurrentSearches
      • MaxConcurrentShardRequests
      • PreFilterShardSize
      • SearchType
      • SupportsBody
      • TotalHitsAsInteger
      • TypedKeys
    • Implements
    • Extension Methods
    Back to top Generated by DocFX