Class PutComponentTemplateRequest

Request for PutComponentTemplate

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

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

Constructors

| Edit this page View Source

PutComponentTemplateRequest()

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

Declaration
protected PutComponentTemplateRequest()
| Edit this page View Source

PutComponentTemplateRequest(Name)

/_component_template/{name}

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

this parameter is required

Properties

| 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 component templates.

Declaration
public bool? Create { get; set; }
Property Value
Type Description
bool?
| 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

Meta

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

Self

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

Template

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

Timeout

Operation timeout.

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

Version

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

Implements

Extension Methods