Class MultiSearchTemplateDescriptor
Descriptor for MultiSearchTemplate
https://opensearch.org/docs/latest/opensearch/rest-api/multi-search/
Inheritance
MultiSearchTemplateDescriptor
Assembly: OpenSearch.Client.dll
Syntax
public class MultiSearchTemplateDescriptor : RequestDescriptorBase<MultiSearchTemplateDescriptor, MultiSearchTemplateRequestParameters, IMultiSearchTemplateRequest>, IDescriptor, IMultiSearchTemplateRequest, IRequest<MultiSearchTemplateRequestParameters>, IRequest
Constructors
|
Edit this page
View Source
MultiSearchTemplateDescriptor()
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
|
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 MultiSearchTemplateDescriptor 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 MultiSearchTemplateDescriptor 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 MultiSearchTemplateDescriptor 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 MultiSearchTemplateDescriptor MaxConcurrentSearches(long? maxconcurrentsearches)
Parameters
Type |
Name |
Description |
long? |
maxconcurrentsearches |
|
Returns
|
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
Overrides
|
Edit this page
View Source
SearchType(SearchType?)
Declaration
public MultiSearchTemplateDescriptor SearchType(SearchType? searchtype)
Parameters
Returns
|
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
Returns
Type Parameters
|
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
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 MultiSearchTemplateDescriptor 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 MultiSearchTemplateDescriptor TypedKeys(bool? typedkeys = true)
Parameters
Type |
Name |
Description |
bool? |
typedkeys |
|
Returns
Implements
Extension Methods