Class MultiSearchDescriptor
Descriptor for MultiSearch
https://opensearch.org/docs/latest/opensearch/rest-api/multi-search/
Inheritance
MultiSearchDescriptor
Assembly: OpenSearch.Client.dll
Syntax
public class MultiSearchDescriptor : RequestDescriptorBase<MultiSearchDescriptor, MultiSearchRequestParameters, IMultiSearchRequest>, IDescriptor, IMultiSearchRequest, IRequest<MultiSearchRequestParameters>, IRequest
Constructors
|
Edit this page
View Source
MultiSearchDescriptor()
Declaration
public MultiSearchDescriptor()
|
Edit this page
View Source
MultiSearchDescriptor(Indices)
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
|
Edit this page
View Source
CcsMinimizeRoundtrips(bool?)
Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution
Declaration
public MultiSearchDescriptor CcsMinimizeRoundtrips(bool? ccsminimizeroundtrips = true)
Parameters
Type |
Name |
Description |
bool? |
ccsminimizeroundtrips |
|
Returns
|
Edit this page
View Source
Index(Indices)
A comma-separated list of index names to use as default
Declaration
public MultiSearchDescriptor Index(Indices index)
Parameters
Type |
Name |
Description |
Indices |
index |
|
Returns
|
Edit this page
View Source
Index<TOther>()
a shortcut into calling Index(typeof(TOther))
Declaration
public MultiSearchDescriptor Index<TOther>() where TOther : class
Returns
Type Parameters
|
Edit this page
View Source
MaxConcurrentSearches(long?)
Controls the maximum number of concurrent searches the multi search api will execute
Declaration
public MultiSearchDescriptor MaxConcurrentSearches(long? maxconcurrentsearches)
Parameters
Type |
Name |
Description |
long? |
maxconcurrentsearches |
|
Returns
|
Edit this page
View Source
MaxConcurrentShardRequests(long?)
The number of concurrent shard requests each sub search executes concurrently per node. 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
Declaration
public MultiSearchDescriptor MaxConcurrentShardRequests(long? maxconcurrentshardrequests)
Parameters
Type |
Name |
Description |
long? |
maxconcurrentshardrequests |
|
Returns
|
Edit this page
View Source
PreFilterShardSize(long?)
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 ie. 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
|
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
Overrides
|
Edit this page
View Source
SearchType(SearchType?)
Declaration
public MultiSearchDescriptor SearchType(SearchType? searchtype)
Parameters
Returns
|
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
Returns
Type Parameters
|
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
Returns
Type Parameters
|
Edit this page
View Source
TotalHitsAsInteger(bool?)
Indicates whether hits.total should be rendered as an integer or an object in the rest search response
Declaration
public MultiSearchDescriptor TotalHitsAsInteger(bool? totalhitsasinteger = true)
Parameters
Type |
Name |
Description |
bool? |
totalhitsasinteger |
|
Returns
|
Edit this page
View Source
TypedKeys(bool?)
Specify 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
Implements
Extension Methods