Class ComposableIndexTemplateExistsDescriptor
Descriptor for ComposableTemplateExists
https://opensearch.org/docs/latest/im-plugin/index-templates/
Inheritance
RequestDescriptorBase <ComposableIndexTemplateExistsDescriptor , ComposableIndexTemplateExistsRequestParameters , IComposableIndexTemplateExistsRequest >
ComposableIndexTemplateExistsDescriptor
Implements
Inherited Members
Namespace: OpenSearch .Client
Assembly: OpenSearch.Client.dll
Syntax
public class ComposableIndexTemplateExistsDescriptor : RequestDescriptorBase<ComposableIndexTemplateExistsDescriptor, ComposableIndexTemplateExistsRequestParameters, IComposableIndexTemplateExistsRequest>, IDescriptor, IComposableIndexTemplateExistsRequest, IRequest<ComposableIndexTemplateExistsRequestParameters>, IRequestConstructors
| Edit this page View SourceComposableIndexTemplateExistsDescriptor()
Used for serialization purposes, making sure we have a parameterless constructor
Declaration
protected ComposableIndexTemplateExistsDescriptor()ComposableIndexTemplateExistsDescriptor(Name)
/_index_template/{name}
Declaration
public ComposableIndexTemplateExistsDescriptor(Name name)Parameters
| Type | Name | Description |
|---|---|---|
| Name | name | this parameter is required |
Methods
| Edit this page View SourceClusterManagerTimeout(Time)
Operation timeout for connection to cluster-manager node.
Declaration
public ComposableIndexTemplateExistsDescriptor ClusterManagerTimeout(Time clustermanagertimeout)Parameters
| Type | Name | Description |
|---|---|---|
| Time | clustermanagertimeout |
Returns
| Type | Description |
|---|---|
| Composable |
Remarks
Supported by OpenSearch servers of version 2.0.0 or greater.
FlatSettings(bool?)
Return settings in flat format.
Declaration
public ComposableIndexTemplateExistsDescriptor FlatSettings(bool? flatsettings = true)Parameters
| Type | Name | Description |
|---|---|---|
| bool? | flatsettings |
Returns
| Type | Description |
|---|---|
| Composable |
Local(bool?)
Return local information, do not retrieve the state from cluster-manager node.
Declaration
public ComposableIndexTemplateExistsDescriptor Local(bool? local = true)Parameters
| Type | Name | Description |
|---|---|---|
| bool? | local |
Returns
| Type | Description |
|---|---|
| Composable |
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 ComposableIndexTemplateExistsDescriptor MasterTimeout(Time mastertimeout)Parameters
| Type | Name | Description |
|---|---|---|
| Time | mastertimeout |
Returns
| Type | Description |
|---|---|
| Composable |