Class GetComposableIndexTemplateDescriptor

Descriptor for GetComposableTemplate

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

Inheritance
object
RequestBase<GetComposableIndexTemplateRequestParameters>
RequestDescriptorBase<GetComposableIndexTemplateDescriptor, GetComposableIndexTemplateRequestParameters, IGetComposableIndexTemplateRequest>
GetComposableIndexTemplateDescriptor
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class GetComposableIndexTemplateDescriptor : RequestDescriptorBase<GetComposableIndexTemplateDescriptor, GetComposableIndexTemplateRequestParameters, IGetComposableIndexTemplateRequest>, IDescriptor, IGetComposableIndexTemplateRequest, IRequest<GetComposableIndexTemplateRequestParameters>, IRequest

Constructors

| Edit this page View Source

GetComposableIndexTemplateDescriptor()

/_index_template

Declaration
public GetComposableIndexTemplateDescriptor()
| Edit this page View Source

GetComposableIndexTemplateDescriptor(Name)

/_index_template/{name}

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

Optional, accepts null

Methods

| Edit this page View Source

ClusterManagerTimeout(Time)

Operation timeout for connection to cluster-manager node.

Declaration
public GetComposableIndexTemplateDescriptor ClusterManagerTimeout(Time clustermanagertimeout)
Parameters
Type Name Description
Time clustermanagertimeout
Returns
Type Description
GetComposableIndexTemplateDescriptor
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 GetComposableIndexTemplateDescriptor FlatSettings(bool? flatsettings = true)
Parameters
Type Name Description
bool? flatsettings
Returns
Type Description
GetComposableIndexTemplateDescriptor
| Edit this page View Source

Local(bool?)

If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the cluster-manager node.

Declaration
public GetComposableIndexTemplateDescriptor Local(bool? local = true)
Parameters
Type Name Description
bool? local
Returns
Type Description
GetComposableIndexTemplateDescriptor
| 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 GetComposableIndexTemplateDescriptor MasterTimeout(Time mastertimeout)
Parameters
Type Name Description
Time mastertimeout
Returns
Type Description
GetComposableIndexTemplateDescriptor
| Edit this page View Source

Name(Name)

Name of the index template to retrieve. Wildcard (*) expressions are supported.

Declaration
public GetComposableIndexTemplateDescriptor Name(Name name)
Parameters
Type Name Description
Name name
Returns
Type Description
GetComposableIndexTemplateDescriptor

Implements

Extension Methods