Search Results for

    Show / Hide Table of Contents

    Class SimulateTemplateRequestParameters

    Request options for SimulateTemplate

    https://opensearch.org/docs/latest

    Inheritance
    object
    RequestParameters<SimulateTemplateRequestParameters>
    SimulateTemplateRequestParameters
    Implements
    IRequestParameters
    Inherited Members
    RequestParameters<SimulateTemplateRequestParameters>.CustomResponseBuilder
    RequestParameters<SimulateTemplateRequestParameters>.QueryString
    RequestParameters<SimulateTemplateRequestParameters>.RequestConfiguration
    RequestParameters<SimulateTemplateRequestParameters>.ContainsQueryString(string)
    RequestParameters<SimulateTemplateRequestParameters>.GetQueryStringValue<TOut>(string)
    RequestParameters<SimulateTemplateRequestParameters>.GetResolvedQueryStringValue(string, IConnectionConfigurationValues)
    RequestParameters<SimulateTemplateRequestParameters>.SetQueryString(string, object)
    RequestParameters<SimulateTemplateRequestParameters>.Q<TOut>(string)
    RequestParameters<SimulateTemplateRequestParameters>.Q(string, object)
    RequestParameters<SimulateTemplateRequestParameters>.SetAcceptHeader(string)
    RequestParameters<SimulateTemplateRequestParameters>.AcceptHeaderFromFormat(string)
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: OpenSearch.Net.Specification.IndicesApi
    Assembly: OpenSearch.Net.dll
    Syntax
    public class SimulateTemplateRequestParameters : RequestParameters<SimulateTemplateRequestParameters>, IRequestParameters

    Properties

    | Edit this page View Source

    Cause

    User defined reason for dry-run creating the new template for simulation purposes.

    Declaration
    public string Cause { get; set; }
    Property Value
    Type Description
    string
    | Edit this page View Source

    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.

    | Edit this page View Source

    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?
    | Edit this page View Source

    DefaultHttpMethod

    Declaration
    public override HttpMethod DefaultHttpMethod { get; }
    Property Value
    Type Description
    HttpMethod
    Overrides
    RequestParameters<SimulateTemplateRequestParameters>.DefaultHttpMethod
    | Edit this page View Source

    MasterTimeout

    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
    | Edit this page View Source

    SupportsBody

    Declaration
    public override bool SupportsBody { get; }
    Property Value
    Type Description
    bool
    Overrides
    RequestParameters<SimulateTemplateRequestParameters>.SupportsBody

    Implements

    IRequestParameters

    Extension Methods

    SuffixExtensions.Suffix(object, string)
    • Edit this page
    • View Source
    In this article
    • Properties
      • Cause
      • ClusterManagerTimeout
      • Create
      • DefaultHttpMethod
      • MasterTimeout
      • SupportsBody
    • Implements
    • Extension Methods
    Back to top Generated by DocFX