Search Results for

    Show / Hide Table of Contents

    Class MultiSearchDescriptor

    Descriptor for MultiSearch

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

    Inheritance
    object
    RequestBase<MultiSearchRequestParameters>
    RequestDescriptorBase<MultiSearchDescriptor, MultiSearchRequestParameters, IMultiSearchRequest>
    MultiSearchDescriptor
    Implements
    IDescriptor
    IMultiSearchRequest
    IRequest<MultiSearchRequestParameters>
    IRequest
    Inherited Members
    RequestDescriptorBase<MultiSearchDescriptor, MultiSearchRequestParameters, IMultiSearchRequest>.Self
    RequestDescriptorBase<MultiSearchDescriptor, MultiSearchRequestParameters, IMultiSearchRequest>.Assign<TValue>(TValue, Action<IMultiSearchRequest, TValue>)
    RequestDescriptorBase<MultiSearchDescriptor, MultiSearchRequestParameters, IMultiSearchRequest>.Qs(string, object)
    RequestDescriptorBase<MultiSearchDescriptor, MultiSearchRequestParameters, IMultiSearchRequest>.RequestConfiguration(Func<RequestConfigurationDescriptor, IRequestConfiguration>)
    RequestDescriptorBase<MultiSearchDescriptor, MultiSearchRequestParameters, IMultiSearchRequest>.ErrorTrace(bool?)
    RequestDescriptorBase<MultiSearchDescriptor, MultiSearchRequestParameters, IMultiSearchRequest>.FilterPath(params string[])
    RequestDescriptorBase<MultiSearchDescriptor, MultiSearchRequestParameters, IMultiSearchRequest>.FilterPath(IEnumerable<string>)
    RequestDescriptorBase<MultiSearchDescriptor, MultiSearchRequestParameters, IMultiSearchRequest>.Human(bool?)
    RequestDescriptorBase<MultiSearchDescriptor, MultiSearchRequestParameters, IMultiSearchRequest>.Pretty(bool?)
    RequestDescriptorBase<MultiSearchDescriptor, MultiSearchRequestParameters, IMultiSearchRequest>.SourceQueryString(string)
    RequestBase<MultiSearchRequestParameters>.HttpMethod
    RequestBase<MultiSearchRequestParameters>.RequestState
    RequestBase<MultiSearchRequestParameters>.ContentType
    RequestBase<MultiSearchRequestParameters>.ResolveUrl(RouteValues, IConnectionSettingsValues)
    RequestBase<MultiSearchRequestParameters>.Q<TOut>(string)
    RequestBase<MultiSearchRequestParameters>.Q(string, object)
    RequestBase<MultiSearchRequestParameters>.SetAcceptHeader(string)
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: OpenSearch.Client
    Assembly: OpenSearch.Client.dll
    Syntax
    public class MultiSearchDescriptor : RequestDescriptorBase<MultiSearchDescriptor, MultiSearchRequestParameters, IMultiSearchRequest>, IDescriptor, IMultiSearchRequest, IRequest<MultiSearchRequestParameters>, IRequest

    Constructors

    | Edit this page View Source

    MultiSearchDescriptor()

    /_msearch

    Declaration
    public MultiSearchDescriptor()
    | Edit this page View Source

    MultiSearchDescriptor(Indices)

    /{index}/_msearch

    Declaration
    public MultiSearchDescriptor(Indices index)
    Parameters
    Type Name Description
    Indices index

    Optional, accepts null

    Methods

    | Edit this page View Source

    AllIndices()

    A shortcut into calling Index(Indices.All)

    Declaration
    public MultiSearchDescriptor AllIndices()
    Returns
    Type Description
    MultiSearchDescriptor
    | Edit this page View Source

    CcsMinimizeRoundtrips(bool?)

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

    Declaration
    public MultiSearchDescriptor CcsMinimizeRoundtrips(bool? ccsminimizeroundtrips = true)
    Parameters
    Type Name Description
    bool? ccsminimizeroundtrips
    Returns
    Type Description
    MultiSearchDescriptor
    | Edit this page View Source

    Index(Indices)

    Comma-separated list of data streams, indexes, and index aliases to search.

    Declaration
    public MultiSearchDescriptor Index(Indices index)
    Parameters
    Type Name Description
    Indices index
    Returns
    Type Description
    MultiSearchDescriptor
    | Edit this page View Source

    Index<TOther>()

    a shortcut into calling Index(typeof(TOther))

    Declaration
    public MultiSearchDescriptor Index<TOther>() where TOther : class
    Returns
    Type Description
    MultiSearchDescriptor
    Type Parameters
    Name Description
    TOther
    | Edit this page View Source

    MaxConcurrentSearches(int?)

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

    Declaration
    public MultiSearchDescriptor MaxConcurrentSearches(int? maxconcurrentsearches)
    Parameters
    Type Name Description
    int? maxconcurrentsearches
    Returns
    Type Description
    MultiSearchDescriptor
    | Edit this page View Source

    MaxConcurrentShardRequests(int?)

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

    Declaration
    public MultiSearchDescriptor MaxConcurrentShardRequests(int? maxconcurrentshardrequests)
    Parameters
    Type Name Description
    int? maxconcurrentshardrequests
    Returns
    Type Description
    MultiSearchDescriptor
    | Edit this page View Source

    PreFilterShardSize(int?)

    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 MultiSearchDescriptor PreFilterShardSize(int? prefiltershardsize)
    Parameters
    Type Name Description
    int? prefiltershardsize
    Returns
    Type Description
    MultiSearchDescriptor
    | Edit this page View Source

    RequestDefaults(MultiSearchRequestParameters)

    Allows a request implementation to set certain request parameter defaults, use sparingly!

    Declaration
    protected override sealed void RequestDefaults(MultiSearchRequestParameters parameters)
    Parameters
    Type Name Description
    MultiSearchRequestParameters parameters
    Overrides
    RequestBase<MultiSearchRequestParameters>.RequestDefaults(MultiSearchRequestParameters)
    | Edit this page View Source

    SearchType(SearchType?)

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

    Declaration
    public MultiSearchDescriptor SearchType(SearchType? searchtype)
    Parameters
    Type Name Description
    SearchType? searchtype
    Returns
    Type Description
    MultiSearchDescriptor
    | Edit this page View Source

    Search<T>(Func<SearchDescriptor<T>, ISearchRequest>)

    Declaration
    public MultiSearchDescriptor Search<T>(Func<SearchDescriptor<T>, ISearchRequest> searchSelector) where T : class
    Parameters
    Type Name Description
    Func<SearchDescriptor<T>, ISearchRequest> searchSelector
    Returns
    Type Description
    MultiSearchDescriptor
    Type Parameters
    Name Description
    T
    | Edit this page View Source

    Search<T>(string, Func<SearchDescriptor<T>, ISearchRequest>)

    Declaration
    public MultiSearchDescriptor Search<T>(string name, Func<SearchDescriptor<T>, ISearchRequest> searchSelector) where T : class
    Parameters
    Type Name Description
    string name
    Func<SearchDescriptor<T>, ISearchRequest> searchSelector
    Returns
    Type Description
    MultiSearchDescriptor
    Type Parameters
    Name Description
    T
    | Edit this page View Source

    TotalHitsAsInteger(bool?)

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

    Declaration
    public MultiSearchDescriptor TotalHitsAsInteger(bool? totalhitsasinteger = true)
    Parameters
    Type Name Description
    bool? totalhitsasinteger
    Returns
    Type Description
    MultiSearchDescriptor
    | Edit this page View Source

    TypedKeys(bool?)

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

    Declaration
    public MultiSearchDescriptor TypedKeys(bool? typedkeys = true)
    Parameters
    Type Name Description
    bool? typedkeys
    Returns
    Type Description
    MultiSearchDescriptor

    Implements

    IDescriptor
    IMultiSearchRequest
    IRequest<TParameters>
    IRequest

    Extension Methods

    SuffixExtensions.Suffix(object, string)
    • Edit this page
    • View Source
    In this article
    • Constructors
      • MultiSearchDescriptor()
      • MultiSearchDescriptor(Indices)
    • Methods
      • AllIndices()
      • CcsMinimizeRoundtrips(bool?)
      • Index(Indices)
      • Index<TOther>()
      • MaxConcurrentSearches(int?)
      • MaxConcurrentShardRequests(int?)
      • PreFilterShardSize(int?)
      • RequestDefaults(MultiSearchRequestParameters)
      • SearchType(SearchType?)
      • Search<T>(Func<SearchDescriptor<T>, ISearchRequest>)
      • Search<T>(string, Func<SearchDescriptor<T>, ISearchRequest>)
      • TotalHitsAsInteger(bool?)
      • TypedKeys(bool?)
    • Implements
    • Extension Methods
    Back to top Generated by DocFX