Class PutComposableIndexTemplateRequest

Request for PutComposableTemplate

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

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

Constructors

| Edit this page View Source

PutComposableIndexTemplateRequest()

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

Declaration
protected PutComposableIndexTemplateRequest()
| Edit this page View Source

PutComposableIndexTemplateRequest(Name)

/_index_template/{name}

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

this parameter is required

Properties

| Edit this page View Source

Cause

User defined reason for creating/updating the index template.

Declaration
public string Cause { get; set; }
Property Value
Type Description
string
| Edit this page View Source

ClusterManagerTimeout

Operation timeout for connection to cluster-manager node.

Declaration
public Time ClusterManagerTimeout { get; set; }
Property Value
Type Description
Time
Remarks

Supported by OpenSearch servers of version 2.0.0 or greater.

| Edit this page View Source

ComposedOf

Declaration
public IReadOnlyCollection<string> ComposedOf { get; set; }
Property Value
Type Description
IReadOnlyCollection<string>
| Edit this page View Source

Create

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

Declaration
public bool? Create { get; set; }
Property Value
Type Description
bool?
| Edit this page View Source

DataStream

Declaration
public IDataStreamTemplate DataStream { get; set; }
Property Value
Type Description
IDataStreamTemplate
| Edit this page View Source

IndexPatterns

Declaration
public IReadOnlyCollection<string> IndexPatterns { get; set; }
Property Value
Type Description
IReadOnlyCollection<string>
| Edit this page View Source

MasterTimeout

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 Time MasterTimeout { get; set; }
Property Value
Type Description
Time
| Edit this page View Source

Meta

Declaration
public IDictionary<string, object> Meta { get; set; }
Property Value
Type Description
IDictionary<string, object>
| Edit this page View Source

Priority

Declaration
public long? Priority { get; set; }
Property Value
Type Description
long?
| Edit this page View Source

Self

Declaration
protected IPutComposableIndexTemplateRequest Self { get; }
Property Value
Type Description
IPutComposableIndexTemplateRequest
| Edit this page View Source

Template

Declaration
public ITemplate Template { get; set; }
Property Value
Type Description
ITemplate
| Edit this page View Source

Version

Declaration
public long? Version { get; set; }
Property Value
Type Description
long?

Implements

Extension Methods