Class RenderSearchTemplateDescriptor

Descriptor for RenderSearchTemplate

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

Inheritance
object
RequestBase<RenderSearchTemplateRequestParameters>
RequestDescriptorBase<RenderSearchTemplateDescriptor, RenderSearchTemplateRequestParameters, IRenderSearchTemplateRequest>
RenderSearchTemplateDescriptor
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class RenderSearchTemplateDescriptor : RequestDescriptorBase<RenderSearchTemplateDescriptor, RenderSearchTemplateRequestParameters, IRenderSearchTemplateRequest>, IDescriptor, IRenderSearchTemplateRequest, IRequest<RenderSearchTemplateRequestParameters>, IRequest

Constructors

| Edit this page View Source

RenderSearchTemplateDescriptor()

/_render/template

Declaration
public RenderSearchTemplateDescriptor()
| Edit this page View Source

RenderSearchTemplateDescriptor(Id)

/_render/template/{id}

Declaration
public RenderSearchTemplateDescriptor(Id id)
Parameters
Type Name Description
Id id

Optional, accepts null

Methods

| Edit this page View Source

File(string)

Declaration
public RenderSearchTemplateDescriptor File(string file)
Parameters
Type Name Description
string file
Returns
Type Description
RenderSearchTemplateDescriptor
| Edit this page View Source

Id(Id)

ID of the search template to render. If no source is specified, this or the id request body parameter is required.

Declaration
public RenderSearchTemplateDescriptor Id(Id id)
Parameters
Type Name Description
Id id
Returns
Type Description
RenderSearchTemplateDescriptor
| Edit this page View Source

Params(Dictionary<string, object>)

Declaration
public RenderSearchTemplateDescriptor Params(Dictionary<string, object> scriptParams)
Parameters
Type Name Description
Dictionary<string, object> scriptParams
Returns
Type Description
RenderSearchTemplateDescriptor
| Edit this page View Source

Params(Func<FluentDictionary<string, object>, FluentDictionary<string, object>>)

Declaration
public RenderSearchTemplateDescriptor Params(Func<FluentDictionary<string, object>, FluentDictionary<string, object>> paramsSelector)
Parameters
Type Name Description
Func<FluentDictionary<string, object>, FluentDictionary<string, object>> paramsSelector
Returns
Type Description
RenderSearchTemplateDescriptor
| Edit this page View Source

Source(string)

Declaration
public RenderSearchTemplateDescriptor Source(string source)
Parameters
Type Name Description
string source
Returns
Type Description
RenderSearchTemplateDescriptor

Implements

Extension Methods