Class GetIndexTemplateRequest

Request for GetTemplate

https://opensearch.org/docs/latest

Inheritance
object
RequestBase<GetIndexTemplateRequestParameters>
PlainRequestBase<GetIndexTemplateRequestParameters>
GetIndexTemplateRequest
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class GetIndexTemplateRequest : PlainRequestBase<GetIndexTemplateRequestParameters>, IGetIndexTemplateRequest, IRequest<GetIndexTemplateRequestParameters>, IRequest

Constructors

| Edit this page View Source

GetIndexTemplateRequest()

/_template

Declaration
public GetIndexTemplateRequest()
| Edit this page View Source

GetIndexTemplateRequest(Names)

/_template/{name}

Declaration
public GetIndexTemplateRequest(Names name)
Parameters
Type Name Description
Names name

Optional, accepts null

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

FlatSettings

If true, returns settings in flat format.

Declaration
public bool? FlatSettings { 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

Local

If true, the request retrieves information from the local node only.

Declaration
public bool? Local { 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

Self

Declaration
protected IGetIndexTemplateRequest Self { get; }
Property Value
Type Description
IGetIndexTemplateRequest

Implements

Extension Methods