Class GetIndexTemplateDescriptor
Descriptor for GetTemplate
https://opensearch.org/docs/latest/opensearch/rest-api/cat/cat-templates/
Inheritance
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 SourceGetIndexTemplateDescriptor()
/_template
Declaration
public GetIndexTemplateDescriptor()
GetIndexTemplateDescriptor(Names)
/_template/{name}
Declaration
public GetIndexTemplateDescriptor(Names name)
Parameters
Type | Name | Description |
---|---|---|
Names | name | Optional, accepts null |
Methods
| Edit this page View SourceClusterManagerTimeout(Time)
Specify timeout for connection to cluster_manager node
Declaration
public GetIndexTemplateDescriptor ClusterManagerTimeout(Time timeout)
Parameters
Type | Name | Description |
---|---|---|
Time | timeout |
Returns
Type | Description |
---|---|
GetIndexTemplateDescriptor |
Remarks
Introduced in OpenSearch 2.0 instead of MasterTimeout(Time)
FlatSettings(bool?)
Return settings in flat format (default: false)
Declaration
public GetIndexTemplateDescriptor FlatSettings(bool? flatsettings = true)
Parameters
Type | Name | Description |
---|---|---|
bool? | flatsettings |
Returns
Type | Description |
---|---|
GetIndexTemplateDescriptor |
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
Local(bool?)
Return local information, do not retrieve the state from cluster_manager node (default: false)
Declaration
public GetIndexTemplateDescriptor Local(bool? local = true)
Parameters
Type | Name | Description |
---|---|---|
bool? | local |
Returns
Type | Description |
---|---|
GetIndexTemplateDescriptor |
MasterTimeout(Time)
Specify timeout for connection to master node
Declaration
public GetIndexTemplateDescriptor MasterTimeout(Time mastertimeout)
Parameters
Type | Name | Description |
---|---|---|
Time | mastertimeout |
Returns
Type | Description |
---|---|
GetIndexTemplateDescriptor |
Remarks
Deprecated as of OpenSearch 2.0, use ClusterManagerTimeout(Time) instead
Name(Names)
The comma separated names of the index templates
Declaration
public GetIndexTemplateDescriptor Name(Names name)
Parameters
Type | Name | Description |
---|---|---|
Names | name |
Returns
Type | Description |
---|---|
GetIndexTemplateDescriptor |