Class PutComposableIndexTemplateDescriptor

Descriptor for PutComposableTemplate

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

Inheritance
object
RequestBase<PutComposableIndexTemplateRequestParameters>
RequestDescriptorBase<PutComposableIndexTemplateDescriptor, PutComposableIndexTemplateRequestParameters, IPutComposableIndexTemplateRequest>
PutComposableIndexTemplateDescriptor
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class PutComposableIndexTemplateDescriptor : RequestDescriptorBase<PutComposableIndexTemplateDescriptor, PutComposableIndexTemplateRequestParameters, IPutComposableIndexTemplateRequest>, IDescriptor, IPutComposableIndexTemplateRequest, IComposableIndexTemplate, IRequest<PutComposableIndexTemplateRequestParameters>, IRequest

Constructors

| Edit this page View Source

PutComposableIndexTemplateDescriptor()

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

Declaration
protected PutComposableIndexTemplateDescriptor()
| Edit this page View Source

PutComposableIndexTemplateDescriptor(Name)

/_index_template/{name}

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

this parameter is required

Methods

| Edit this page View Source

Cause(string)

User defined reason for creating/updating the index template.

Declaration
public PutComposableIndexTemplateDescriptor Cause(string cause)
Parameters
Type Name Description
string cause
Returns
Type Description
PutComposableIndexTemplateDescriptor
| Edit this page View Source

ClusterManagerTimeout(Time)

Operation timeout for connection to cluster-manager node.

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

Supported by OpenSearch servers of version 2.0.0 or greater.

| Edit this page View Source

ComposedOf(IEnumerable<string>)

Declaration
public PutComposableIndexTemplateDescriptor ComposedOf(IEnumerable<string> composedOf)
Parameters
Type Name Description
IEnumerable<string> composedOf
Returns
Type Description
PutComposableIndexTemplateDescriptor
| Edit this page View Source

ComposedOf(params string[])

Declaration
public PutComposableIndexTemplateDescriptor ComposedOf(params string[] composedOf)
Parameters
Type Name Description
string[] composedOf
Returns
Type Description
PutComposableIndexTemplateDescriptor
| Edit this page View Source

Create(bool?)

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

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

DataStream(Func<DataStreamTemplateDescriptor, IDataStreamTemplate>)

Declaration
public PutComposableIndexTemplateDescriptor DataStream(Func<DataStreamTemplateDescriptor, IDataStreamTemplate> dataStreamSelector)
Parameters
Type Name Description
Func<DataStreamTemplateDescriptor, IDataStreamTemplate> dataStreamSelector
Returns
Type Description
PutComposableIndexTemplateDescriptor
| Edit this page View Source

IndexPatterns(IEnumerable<string>)

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

IndexPatterns(params string[])

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

MasterTimeout(Time)

Operation timeout for connection to cluster-manager node.

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

Meta(Dictionary<string, object>)

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

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

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

Priority(long?)

Declaration
public PutComposableIndexTemplateDescriptor Priority(long? priority)
Parameters
Type Name Description
long? priority
Returns
Type Description
PutComposableIndexTemplateDescriptor
| Edit this page View Source

Template(Func<TemplateDescriptor, ITemplate>)

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

Version(long?)

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

Implements

Extension Methods