Search Results for

    Show / Hide Table of Contents

    Class GetComponentTemplateRequestParameters

    Request options for GetComponentTemplate

    https://opensearch.org/docs/latest

    Inheritance
    object
    RequestParameters<GetComponentTemplateRequestParameters>
    GetComponentTemplateRequestParameters
    Implements
    IRequestParameters
    Inherited Members
    RequestParameters<GetComponentTemplateRequestParameters>.CustomResponseBuilder
    RequestParameters<GetComponentTemplateRequestParameters>.QueryString
    RequestParameters<GetComponentTemplateRequestParameters>.RequestConfiguration
    RequestParameters<GetComponentTemplateRequestParameters>.ContainsQueryString(string)
    RequestParameters<GetComponentTemplateRequestParameters>.GetQueryStringValue<TOut>(string)
    RequestParameters<GetComponentTemplateRequestParameters>.GetResolvedQueryStringValue(string, IConnectionConfigurationValues)
    RequestParameters<GetComponentTemplateRequestParameters>.SetQueryString(string, object)
    RequestParameters<GetComponentTemplateRequestParameters>.Q<TOut>(string)
    RequestParameters<GetComponentTemplateRequestParameters>.Q(string, object)
    RequestParameters<GetComponentTemplateRequestParameters>.SetAcceptHeader(string)
    RequestParameters<GetComponentTemplateRequestParameters>.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.ClusterApi
    Assembly: OpenSearch.Net.dll
    Syntax
    public class GetComponentTemplateRequestParameters : RequestParameters<GetComponentTemplateRequestParameters>, IRequestParameters

    Properties

    | Edit this page View Source

    ClusterManagerTimeout

    The amount of time to wait for a response from the cluster manager node. For more information about supported time units, see Common parameters.

    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

    DefaultHttpMethod

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

    FlatSettings

    Whether to return settings in the flat form, which can improve readability, especially for heavily nested settings. For example, the flat form of "cluster": { "max_shards_per_node": 500 } is "cluster.max_shards_per_node": "500".

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

    Local

    When true, the request retrieves information from the local node only. When false, 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

    A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts 0 without a unit and -1 to indicate an unspecified value.

    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<GetComponentTemplateRequestParameters>.SupportsBody

    Implements

    IRequestParameters

    Extension Methods

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