Search Results for

    Show / Hide Table of Contents

    Class GetComposableIndexTemplateRequest

    Request for GetComposableTemplate

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

    Inheritance
    object
    RequestBase<GetComposableIndexTemplateRequestParameters>
    PlainRequestBase<GetComposableIndexTemplateRequestParameters>
    GetComposableIndexTemplateRequest
    Implements
    IGetComposableIndexTemplateRequest
    IRequest<GetComposableIndexTemplateRequestParameters>
    IRequest
    Inherited Members
    PlainRequestBase<GetComposableIndexTemplateRequestParameters>.RequestConfiguration
    PlainRequestBase<GetComposableIndexTemplateRequestParameters>.ErrorTrace
    PlainRequestBase<GetComposableIndexTemplateRequestParameters>.FilterPath
    PlainRequestBase<GetComposableIndexTemplateRequestParameters>.Human
    PlainRequestBase<GetComposableIndexTemplateRequestParameters>.Pretty
    PlainRequestBase<GetComposableIndexTemplateRequestParameters>.SourceQueryString
    RequestBase<GetComposableIndexTemplateRequestParameters>.HttpMethod
    RequestBase<GetComposableIndexTemplateRequestParameters>.RequestState
    RequestBase<GetComposableIndexTemplateRequestParameters>.ContentType
    RequestBase<GetComposableIndexTemplateRequestParameters>.ResolveUrl(RouteValues, IConnectionSettingsValues)
    RequestBase<GetComposableIndexTemplateRequestParameters>.RequestDefaults(GetComposableIndexTemplateRequestParameters)
    RequestBase<GetComposableIndexTemplateRequestParameters>.Q<TOut>(string)
    RequestBase<GetComposableIndexTemplateRequestParameters>.Q(string, object)
    RequestBase<GetComposableIndexTemplateRequestParameters>.SetAcceptHeader(string)
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: OpenSearch.Client
    Assembly: OpenSearch.Client.dll
    Syntax
    public class GetComposableIndexTemplateRequest : PlainRequestBase<GetComposableIndexTemplateRequestParameters>, IGetComposableIndexTemplateRequest, IRequest<GetComposableIndexTemplateRequestParameters>, IRequest

    Constructors

    | Edit this page View Source

    GetComposableIndexTemplateRequest()

    /_index_template

    Declaration
    public GetComposableIndexTemplateRequest()
    | Edit this page View Source

    GetComposableIndexTemplateRequest(Name)

    /_index_template/{name}

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

    Optional, accepts null

    Properties

    | Edit this page View Source

    ClusterManagerTimeout

    Operation timeout for connection to cluster-manager node.

    Declaration
    public Time ClusterManagerTimeout { get; set; }
    Property Value
    Type Description
    Time
    Remarks

    Supported by OpenSearch servers of version 2.0.0 or greater.

    | Edit this page View Source

    FlatSettings

    If true, returns settings in flat format.

    Declaration
    public bool? FlatSettings { get; set; }
    Property Value
    Type Description
    bool?
    | Edit this page View Source

    Local

    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 bool? Local { get; set; }
    Property Value
    Type Description
    bool?
    | 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 Time MasterTimeout { get; set; }
    Property Value
    Type Description
    Time
    | Edit this page View Source

    Self

    Declaration
    protected IGetComposableIndexTemplateRequest Self { get; }
    Property Value
    Type Description
    IGetComposableIndexTemplateRequest

    Implements

    IGetComposableIndexTemplateRequest
    IRequest<TParameters>
    IRequest

    Extension Methods

    SuffixExtensions.Suffix(object, string)
    • Edit this page
    • View Source
    In this article
    • Constructors
      • GetComposableIndexTemplateRequest()
      • GetComposableIndexTemplateRequest(Name)
    • Properties
      • ClusterManagerTimeout
      • FlatSettings
      • Local
      • MasterTimeout
      • Self
    • Implements
    • Extension Methods
    Back to top Generated by DocFX