Search Results for

    Show / Hide Table of Contents

    Class PutComponentTemplateRequest

    Request for PutComponentTemplate

    https://opensearch.org/docs/latest/im-plugin/index-templates/#use-component-templates-to-create-an-index-template

    Inheritance
    object
    RequestBase<PutComponentTemplateRequestParameters>
    PlainRequestBase<PutComponentTemplateRequestParameters>
    PutComponentTemplateRequest
    Implements
    IPutComponentTemplateRequest
    IComponentTemplate
    IRequest<PutComponentTemplateRequestParameters>
    IRequest
    Inherited Members
    PlainRequestBase<PutComponentTemplateRequestParameters>.RequestConfiguration
    PlainRequestBase<PutComponentTemplateRequestParameters>.ErrorTrace
    PlainRequestBase<PutComponentTemplateRequestParameters>.FilterPath
    PlainRequestBase<PutComponentTemplateRequestParameters>.Human
    PlainRequestBase<PutComponentTemplateRequestParameters>.Pretty
    PlainRequestBase<PutComponentTemplateRequestParameters>.SourceQueryString
    RequestBase<PutComponentTemplateRequestParameters>.HttpMethod
    RequestBase<PutComponentTemplateRequestParameters>.RequestState
    RequestBase<PutComponentTemplateRequestParameters>.ContentType
    RequestBase<PutComponentTemplateRequestParameters>.ResolveUrl(RouteValues, IConnectionSettingsValues)
    RequestBase<PutComponentTemplateRequestParameters>.RequestDefaults(PutComponentTemplateRequestParameters)
    RequestBase<PutComponentTemplateRequestParameters>.Q<TOut>(string)
    RequestBase<PutComponentTemplateRequestParameters>.Q(string, object)
    RequestBase<PutComponentTemplateRequestParameters>.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 PutComponentTemplateRequest : PlainRequestBase<PutComponentTemplateRequestParameters>, IPutComponentTemplateRequest, IComponentTemplate, IRequest<PutComponentTemplateRequestParameters>, IRequest

    Constructors

    | Edit this page View Source

    PutComponentTemplateRequest()

    Used for serialization purposes, making sure we have a parameterless constructor

    Declaration
    protected PutComponentTemplateRequest()
    | Edit this page View Source

    PutComponentTemplateRequest(Name)

    /_component_template/{name}

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

    this parameter is required

    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 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

    Create

    When true, this request cannot replace or update existing component templates.

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

    Meta

    Declaration
    public IDictionary<string, object> Meta { get; set; }
    Property Value
    Type Description
    IDictionary<string, object>
    | Edit this page View Source

    Self

    Declaration
    protected IPutComponentTemplateRequest Self { get; }
    Property Value
    Type Description
    IPutComponentTemplateRequest
    | Edit this page View Source

    Template

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

    Timeout

    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
    public Time Timeout { get; set; }
    Property Value
    Type Description
    Time
    | Edit this page View Source

    Version

    Declaration
    public long? Version { get; set; }
    Property Value
    Type Description
    long?

    Implements

    IPutComponentTemplateRequest
    IComponentTemplate
    IRequest<TParameters>
    IRequest

    Extension Methods

    SuffixExtensions.Suffix(object, string)
    • Edit this page
    • View Source
    In this article
    • Constructors
      • PutComponentTemplateRequest()
      • PutComponentTemplateRequest(Name)
    • Properties
      • ClusterManagerTimeout
      • Create
      • MasterTimeout
      • Meta
      • Self
      • Template
      • Timeout
      • Version
    • Implements
    • Extension Methods
    Back to top Generated by DocFX