Class SimulateTemplateRequestParameters
Request options for SimulateTemplate
https://opensearch.org/docs/latest
Inheritance
SimulateTemplateRequestParameters
Implements
Inherited Members
Namespace: OpenSearch.Net.Specification.IndicesApi
Assembly: OpenSearch.Net.dll
Syntax
public class SimulateTemplateRequestParameters : RequestParameters<SimulateTemplateRequestParameters>, IRequestParametersProperties
| Edit this page View SourceCause
User defined reason for dry-run creating the new template for simulation purposes.
Declaration
public string Cause { get; set; }Property Value
| Type | Description |
|---|---|
| string |
ClusterManagerTimeout
Operation timeout for connection to cluster-manager node.
Declaration
public TimeSpan ClusterManagerTimeout { get; set; }Property Value
| Type | Description |
|---|---|
| TimeSpan |
Remarks
Supported by OpenSearch servers of version 2.0.0 or greater.
Create
If true, the template passed in the body is only used if no existing templates match the same index patterns. If false, the simulation
uses the template with the highest priority. Note that the template is not permanently added or updated in either case; it is only used
for the simulation.
Declaration
public bool? Create { get; set; }Property Value
| Type | Description |
|---|---|
| bool? |
DefaultHttpMethod
Declaration
public override HttpMethod DefaultHttpMethod { get; }Property Value
| Type | Description |
|---|---|
| HttpMethod |
Overrides
| Edit this page View SourceMasterTimeout
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 TimeSpan MasterTimeout { get; set; }Property Value
| Type | Description |
|---|---|
| TimeSpan |
SupportsBody
Declaration
public override bool SupportsBody { get; }Property Value
| Type | Description |
|---|---|
| bool |