Class PutIndexTemplateRequest

Request for PutTemplate

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

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

Constructors

| Edit this page View Source

PutIndexTemplateRequest()

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

Declaration
protected PutIndexTemplateRequest()
| Edit this page View Source

PutIndexTemplateRequest(Name)

/_template/{name}

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

this parameter is required

Properties

| Edit this page View Source

Aliases

Declaration
public IAliases Aliases { get; set; }
Property Value
Type Description
IAliases
| 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

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

IncludeTypeName

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

Declaration
public bool? IncludeTypeName { get; set; }
Property Value
Type Description
bool?
Remarks

Deprecated as of OpenSearch 2.0

| Edit this page View Source

IndexPatterns

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

Mappings

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

MasterTimeout

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

Order

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

Self

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

Settings

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

Version

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

Implements

Extension Methods