Class GetIndexTemplateDescriptor

Descriptor for GetTemplate

https://opensearch.org/docs/latest

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

Constructors

| Edit this page View Source

GetIndexTemplateDescriptor()

/_template

Declaration
public GetIndexTemplateDescriptor()
| Edit this page View Source

GetIndexTemplateDescriptor(Names)

/_template/{name}

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

Optional, accepts null

Methods

| Edit this page View Source

ClusterManagerTimeout(Time)

Operation timeout for connection to cluster-manager node.

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

Supported by OpenSearch servers of version 2.0.0 or greater.

| Edit this page View Source

FlatSettings(bool?)

If true, returns settings in flat format.

Declaration
public GetIndexTemplateDescriptor FlatSettings(bool? flatsettings = true)
Parameters
Type Name Description
bool? flatsettings
Returns
Type Description
GetIndexTemplateDescriptor
| Edit this page View Source

IncludeTypeName(bool?)

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

Declaration
public GetIndexTemplateDescriptor IncludeTypeName(bool? includetypename = true)
Parameters
Type Name Description
bool? includetypename
Returns
Type Description
GetIndexTemplateDescriptor
Remarks

Deprecated as of OpenSearch 2.0

| Edit this page View Source

Local(bool?)

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

Declaration
public GetIndexTemplateDescriptor Local(bool? local = true)
Parameters
Type Name Description
bool? local
Returns
Type Description
GetIndexTemplateDescriptor
| Edit this page View Source

MasterTimeout(Time)

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 GetIndexTemplateDescriptor MasterTimeout(Time mastertimeout)
Parameters
Type Name Description
Time mastertimeout
Returns
Type Description
GetIndexTemplateDescriptor
| Edit this page View Source

Name(Names)

Comma-separated list of index template names used to limit the request. Wildcard (*) expressions are supported. To return all index templates, omit this parameter or use a value of _all or *.

Declaration
public GetIndexTemplateDescriptor Name(Names name)
Parameters
Type Name Description
Names name
Returns
Type Description
GetIndexTemplateDescriptor

Implements

Extension Methods