Search Results for

    Show / Hide Table of Contents

    Class PutPipelineRequest

    Request for PutPipeline

    https://opensearch.org/docs/latest/api-reference/ingest-apis/create-update-ingest/

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

    Constructors

    | Edit this page View Source

    PutPipelineRequest()

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

    Declaration
    protected PutPipelineRequest()
    | Edit this page View Source

    PutPipelineRequest(Id)

    /_ingest/pipeline/{id}

    Declaration
    public PutPipelineRequest(Id id)
    Parameters
    Type Name Description
    Id id

    this parameter is required

    Properties

    | Edit this page View Source

    ClusterManagerTimeout

    The amount of time allowed to establish a connection to the 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

    Description

    Declaration
    public string Description { get; set; }
    Property Value
    Type Description
    string
    | 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

    OnFailure

    Declaration
    public IEnumerable<IProcessor> OnFailure { get; set; }
    Property Value
    Type Description
    IEnumerable<IProcessor>
    | Edit this page View Source

    Processors

    Declaration
    public IEnumerable<IProcessor> Processors { get; set; }
    Property Value
    Type Description
    IEnumerable<IProcessor>
    | Edit this page View Source

    Self

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

    Timeout

    The amount of time to wait for a response.

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

    Implements

    IPutPipelineRequest
    IPipeline
    IRequest<TParameters>
    IRequest

    Extension Methods

    SuffixExtensions.Suffix(object, string)
    • Edit this page
    • View Source
    In this article
    • Constructors
      • PutPipelineRequest()
      • PutPipelineRequest(Id)
    • Properties
      • ClusterManagerTimeout
      • Description
      • MasterTimeout
      • OnFailure
      • Processors
      • Self
      • Timeout
    • Implements
    • Extension Methods
    Back to top Generated by DocFX