Class PutIndexTemplateDescriptor

Descriptor for PutTemplate

https://opensearch.org/docs/latest/im-plugin/index-templates/

Inheritance
object
RequestBase<PutIndexTemplateRequestParameters>
RequestDescriptorBase<PutIndexTemplateDescriptor, PutIndexTemplateRequestParameters, IPutIndexTemplateRequest>
PutIndexTemplateDescriptor
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class PutIndexTemplateDescriptor : RequestDescriptorBase<PutIndexTemplateDescriptor, PutIndexTemplateRequestParameters, IPutIndexTemplateRequest>, IDescriptor, IPutIndexTemplateRequest, ITemplateMapping, IRequest<PutIndexTemplateRequestParameters>, IRequest

Constructors

| Edit this page View Source

PutIndexTemplateDescriptor()

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

Declaration
protected PutIndexTemplateDescriptor()
| Edit this page View Source

PutIndexTemplateDescriptor(Name)

/_template/{name}

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

this parameter is required

Methods

| Edit this page View Source

Aliases(Func<AliasesDescriptor, IPromise<IAliases>>)

Declaration
public PutIndexTemplateDescriptor Aliases(Func<AliasesDescriptor, IPromise<IAliases>> aliasDescriptor)
Parameters
Type Name Description
Func<AliasesDescriptor, IPromise<IAliases>> aliasDescriptor
Returns
Type Description
PutIndexTemplateDescriptor
| Edit this page View Source

ClusterManagerTimeout(Time)

Operation timeout for connection to cluster-manager node.

Declaration
public PutIndexTemplateDescriptor ClusterManagerTimeout(Time clustermanagertimeout)
Parameters
Type Name Description
Time clustermanagertimeout
Returns
Type Description
PutIndexTemplateDescriptor
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 index templates.

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

IncludeTypeName(bool?)

Whether a type should be returned in the body of the mappings.

Declaration
public PutIndexTemplateDescriptor IncludeTypeName(bool? includetypename = true)
Parameters
Type Name Description
bool? includetypename
Returns
Type Description
PutIndexTemplateDescriptor
Remarks

Deprecated as of OpenSearch 2.0

| Edit this page View Source

IndexPatterns(IEnumerable<string>)

Declaration
public PutIndexTemplateDescriptor IndexPatterns(IEnumerable<string> patterns)
Parameters
Type Name Description
IEnumerable<string> patterns
Returns
Type Description
PutIndexTemplateDescriptor
| Edit this page View Source

IndexPatterns(params string[])

Declaration
public PutIndexTemplateDescriptor IndexPatterns(params string[] patterns)
Parameters
Type Name Description
string[] patterns
Returns
Type Description
PutIndexTemplateDescriptor
| Edit this page View Source

Map(Func<TypeMappingDescriptor<object>, ITypeMapping>)

Declaration
public PutIndexTemplateDescriptor Map(Func<TypeMappingDescriptor<object>, ITypeMapping> selector)
Parameters
Type Name Description
Func<TypeMappingDescriptor<object>, ITypeMapping> selector
Returns
Type Description
PutIndexTemplateDescriptor
| Edit this page View Source

Map<T>(Func<TypeMappingDescriptor<T>, ITypeMapping>)

Declaration
public PutIndexTemplateDescriptor Map<T>(Func<TypeMappingDescriptor<T>, ITypeMapping> selector) where T : class
Parameters
Type Name Description
Func<TypeMappingDescriptor<T>, ITypeMapping> selector
Returns
Type Description
PutIndexTemplateDescriptor
Type Parameters
Name Description
T
| Edit this page View Source

Mappings(Func<MappingsDescriptor, ITypeMapping>)

Declaration
[Obsolete("Mappings is no longer a dictionary, please use the simplified Map() method on this descriptor instead")]
public PutIndexTemplateDescriptor Mappings(Func<MappingsDescriptor, ITypeMapping> mappingSelector)
Parameters
Type Name Description
Func<MappingsDescriptor, ITypeMapping> mappingSelector
Returns
Type Description
PutIndexTemplateDescriptor
| 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 PutIndexTemplateDescriptor MasterTimeout(Time mastertimeout)
Parameters
Type Name Description
Time mastertimeout
Returns
Type Description
PutIndexTemplateDescriptor
| Edit this page View Source

Order(int?)

Declaration
public PutIndexTemplateDescriptor Order(int? order)
Parameters
Type Name Description
int? order
Returns
Type Description
PutIndexTemplateDescriptor
| Edit this page View Source

Settings(Func<IndexSettingsDescriptor, IPromise<IIndexSettings>>)

Declaration
public PutIndexTemplateDescriptor Settings(Func<IndexSettingsDescriptor, IPromise<IIndexSettings>> settingsSelector)
Parameters
Type Name Description
Func<IndexSettingsDescriptor, IPromise<IIndexSettings>> settingsSelector
Returns
Type Description
PutIndexTemplateDescriptor
| Edit this page View Source

Version(int?)

Declaration
public PutIndexTemplateDescriptor Version(int? version)
Parameters
Type Name Description
int? version
Returns
Type Description
PutIndexTemplateDescriptor

Implements

Extension Methods