Class MultiSearchDescriptor

Descriptor for MultiSearch

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

Inheritance
object
RequestBase<MultiSearchRequestParameters>
RequestDescriptorBase<MultiSearchDescriptor, MultiSearchRequestParameters, IMultiSearchRequest>
MultiSearchDescriptor
Implements
Inherited Members
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(long?)

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

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

MaxConcurrentShardRequests(long?)

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

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

PreFilterShardSize(long?)

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(long? prefiltershardsize)
Parameters
Type Name Description
long? 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
| 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

Extension Methods