Class PutComponentTemplateDescriptor

Descriptor for PutComponentTemplate

https://opensearch.org/docs/latest/im-plugin/index-templates/#use-component-templates-to-create-an-index-template

Inheritance
object
RequestBase<PutComponentTemplateRequestParameters>
RequestDescriptorBase<PutComponentTemplateDescriptor, PutComponentTemplateRequestParameters, IPutComponentTemplateRequest>
PutComponentTemplateDescriptor
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class PutComponentTemplateDescriptor : RequestDescriptorBase<PutComponentTemplateDescriptor, PutComponentTemplateRequestParameters, IPutComponentTemplateRequest>, IDescriptor, IPutComponentTemplateRequest, IComponentTemplate, IRequest<PutComponentTemplateRequestParameters>, IRequest

Constructors

| Edit this page View Source

PutComponentTemplateDescriptor()

Used for serialization purposes, making sure we have a parameterless constructor

Declaration
protected PutComponentTemplateDescriptor()
| Edit this page View Source

PutComponentTemplateDescriptor(Name)

/_component_template/{name}

Declaration
public PutComponentTemplateDescriptor(Name name)
Parameters
Type Name Description
Name name

this parameter is required

Methods

| Edit this page View Source

ClusterManagerTimeout(Time)

Operation timeout for connection to cluster-manager node.

Declaration
public PutComponentTemplateDescriptor ClusterManagerTimeout(Time clustermanagertimeout)
Parameters
Type Name Description
Time clustermanagertimeout
Returns
Type Description
PutComponentTemplateDescriptor
Remarks

Supported by OpenSearch servers of version 2.0.0 or greater.

| Edit this page View Source

Create(bool?)

If true, this request cannot replace or update existing component templates.

Declaration
public PutComponentTemplateDescriptor Create(bool? create = true)
Parameters
Type Name Description
bool? create
Returns
Type Description
PutComponentTemplateDescriptor
| Edit this page View Source

MasterTimeout(Time)

Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error.

Declaration
[Obsolete("Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead.")]
public PutComponentTemplateDescriptor MasterTimeout(Time mastertimeout)
Parameters
Type Name Description
Time mastertimeout
Returns
Type Description
PutComponentTemplateDescriptor
| Edit this page View Source

Meta(Dictionary<string, object>)

Declaration
public PutComponentTemplateDescriptor Meta(Dictionary<string, object> metaDictionary)
Parameters
Type Name Description
Dictionary<string, object> metaDictionary
Returns
Type Description
PutComponentTemplateDescriptor
| Edit this page View Source

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

Declaration
public PutComponentTemplateDescriptor Meta(Func<FluentDictionary<string, object>, FluentDictionary<string, object>> metaSelector)
Parameters
Type Name Description
Func<FluentDictionary<string, object>, FluentDictionary<string, object>> metaSelector
Returns
Type Description
PutComponentTemplateDescriptor
| Edit this page View Source

Template(Func<TemplateDescriptor, ITemplate>)

Declaration
public PutComponentTemplateDescriptor Template(Func<TemplateDescriptor, ITemplate> selector)
Parameters
Type Name Description
Func<TemplateDescriptor, ITemplate> selector
Returns
Type Description
PutComponentTemplateDescriptor
| Edit this page View Source

Timeout(Time)

Operation timeout.

Declaration
public PutComponentTemplateDescriptor Timeout(Time timeout)
Parameters
Type Name Description
Time timeout
Returns
Type Description
PutComponentTemplateDescriptor
| Edit this page View Source

Version(long?)

Declaration
public PutComponentTemplateDescriptor Version(long? version)
Parameters
Type Name Description
long? version
Returns
Type Description
PutComponentTemplateDescriptor

Implements

Extension Methods