Class MultiSearchTemplateDescriptor

Descriptor for MultiSearchTemplate

https://opensearch.org/docs/latest/search-plugins/search-template/

Inheritance
object
RequestBase<MultiSearchTemplateRequestParameters>
RequestDescriptorBase<MultiSearchTemplateDescriptor, MultiSearchTemplateRequestParameters, IMultiSearchTemplateRequest>
MultiSearchTemplateDescriptor
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class MultiSearchTemplateDescriptor : RequestDescriptorBase<MultiSearchTemplateDescriptor, MultiSearchTemplateRequestParameters, IMultiSearchTemplateRequest>, IDescriptor, IMultiSearchTemplateRequest, IRequest<MultiSearchTemplateRequestParameters>, IRequest

Constructors

| Edit this page View Source

MultiSearchTemplateDescriptor()

/_msearch/template

Declaration
public MultiSearchTemplateDescriptor()
| Edit this page View Source

MultiSearchTemplateDescriptor(Indices)

/{index}/_msearch/template

Declaration
public MultiSearchTemplateDescriptor(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 MultiSearchTemplateDescriptor AllIndices()
Returns
Type Description
MultiSearchTemplateDescriptor
| Edit this page View Source

CcsMinimizeRoundtrips(bool?)

If true, network round-trips are minimized for cross-cluster search requests.

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

Index(Indices)

Comma-separated list of data streams, indexes, and aliases to search. Supports wildcards (*). To search all data streams and indexes, omit this parameter or use *.

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

Index<TOther>()

a shortcut into calling Index(typeof(TOther))

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

MaxConcurrentSearches(int?)

Maximum number of concurrent searches the API can run.

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

RequestDefaults(MultiSearchTemplateRequestParameters)

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

Declaration
protected override sealed void RequestDefaults(MultiSearchTemplateRequestParameters parameters)
Parameters
Type Name Description
MultiSearchTemplateRequestParameters parameters
Overrides
| Edit this page View Source

SearchType(SearchType?)

The type of the search operation. Available options: query_then_fetch, dfs_query_then_fetch.

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

Template<T>(Func<SearchTemplateDescriptor<T>, ISearchTemplateRequest>)

Declaration
public MultiSearchTemplateDescriptor Template<T>(Func<SearchTemplateDescriptor<T>, ISearchTemplateRequest> selector) where T : class
Parameters
Type Name Description
Func<SearchTemplateDescriptor<T>, ISearchTemplateRequest> selector
Returns
Type Description
MultiSearchTemplateDescriptor
Type Parameters
Name Description
T
| Edit this page View Source

Template<T>(string, Func<SearchTemplateDescriptor<T>, ISearchTemplateRequest>)

Declaration
public MultiSearchTemplateDescriptor Template<T>(string name, Func<SearchTemplateDescriptor<T>, ISearchTemplateRequest> selector) where T : class
Parameters
Type Name Description
string name
Func<SearchTemplateDescriptor<T>, ISearchTemplateRequest> selector
Returns
Type Description
MultiSearchTemplateDescriptor
Type Parameters
Name Description
T
| Edit this page View Source

TotalHitsAsInteger(bool?)

If true, the response returns hits.total as an integer. If false, it returns hits.total as an object.

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

TypedKeys(bool?)

If true, the response prefixes aggregation and suggester names with their respective types.

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

Implements

Extension Methods