Search Results for

    Show / Hide Table of Contents

    Class GetPipelineDescriptor

    Descriptor for GetPipeline

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

    Inheritance
    object
    RequestBase<GetPipelineRequestParameters>
    RequestDescriptorBase<GetPipelineDescriptor, GetPipelineRequestParameters, IGetPipelineRequest>
    GetPipelineDescriptor
    Implements
    IDescriptor
    IGetPipelineRequest
    IRequest<GetPipelineRequestParameters>
    IRequest
    Inherited Members
    RequestDescriptorBase<GetPipelineDescriptor, GetPipelineRequestParameters, IGetPipelineRequest>.Self
    RequestDescriptorBase<GetPipelineDescriptor, GetPipelineRequestParameters, IGetPipelineRequest>.Assign<TValue>(TValue, Action<IGetPipelineRequest, TValue>)
    RequestDescriptorBase<GetPipelineDescriptor, GetPipelineRequestParameters, IGetPipelineRequest>.Qs(string, object)
    RequestDescriptorBase<GetPipelineDescriptor, GetPipelineRequestParameters, IGetPipelineRequest>.RequestConfiguration(Func<RequestConfigurationDescriptor, IRequestConfiguration>)
    RequestDescriptorBase<GetPipelineDescriptor, GetPipelineRequestParameters, IGetPipelineRequest>.ErrorTrace(bool?)
    RequestDescriptorBase<GetPipelineDescriptor, GetPipelineRequestParameters, IGetPipelineRequest>.FilterPath(params string[])
    RequestDescriptorBase<GetPipelineDescriptor, GetPipelineRequestParameters, IGetPipelineRequest>.FilterPath(IEnumerable<string>)
    RequestDescriptorBase<GetPipelineDescriptor, GetPipelineRequestParameters, IGetPipelineRequest>.Human(bool?)
    RequestDescriptorBase<GetPipelineDescriptor, GetPipelineRequestParameters, IGetPipelineRequest>.Pretty(bool?)
    RequestDescriptorBase<GetPipelineDescriptor, GetPipelineRequestParameters, IGetPipelineRequest>.SourceQueryString(string)
    RequestBase<GetPipelineRequestParameters>.HttpMethod
    RequestBase<GetPipelineRequestParameters>.RequestState
    RequestBase<GetPipelineRequestParameters>.ContentType
    RequestBase<GetPipelineRequestParameters>.ResolveUrl(RouteValues, IConnectionSettingsValues)
    RequestBase<GetPipelineRequestParameters>.RequestDefaults(GetPipelineRequestParameters)
    RequestBase<GetPipelineRequestParameters>.Q<TOut>(string)
    RequestBase<GetPipelineRequestParameters>.Q(string, object)
    RequestBase<GetPipelineRequestParameters>.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 GetPipelineDescriptor : RequestDescriptorBase<GetPipelineDescriptor, GetPipelineRequestParameters, IGetPipelineRequest>, IDescriptor, IGetPipelineRequest, IRequest<GetPipelineRequestParameters>, IRequest

    Constructors

    | Edit this page View Source

    GetPipelineDescriptor()

    /_ingest/pipeline

    Declaration
    public GetPipelineDescriptor()
    | Edit this page View Source

    GetPipelineDescriptor(Id)

    /_ingest/pipeline/{id}

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

    Optional, accepts null

    Methods

    | Edit this page View Source

    ClusterManagerTimeout(Time)

    The amount of time allowed to establish a connection to the cluster manager node.

    Declaration
    public GetPipelineDescriptor ClusterManagerTimeout(Time clustermanagertimeout)
    Parameters
    Type Name Description
    Time clustermanagertimeout
    Returns
    Type Description
    GetPipelineDescriptor
    Remarks

    Supported by OpenSearch servers of version 2.0.0 or greater.

    | Edit this page View Source

    Id(Id)

    A comma-separated list of pipeline IDs to retrieve. Wildcard (*) expressions are supported. To get all ingest pipelines, omit this parameter or use *.

    Declaration
    public GetPipelineDescriptor Id(Id id)
    Parameters
    Type Name Description
    Id id
    Returns
    Type Description
    GetPipelineDescriptor
    | Edit this page View Source

    MasterTimeout(Time)

    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 GetPipelineDescriptor MasterTimeout(Time mastertimeout)
    Parameters
    Type Name Description
    Time mastertimeout
    Returns
    Type Description
    GetPipelineDescriptor

    Implements

    IDescriptor
    IGetPipelineRequest
    IRequest<TParameters>
    IRequest

    Extension Methods

    SuffixExtensions.Suffix(object, string)
    • Edit this page
    • View Source
    In this article
    • Constructors
      • GetPipelineDescriptor()
      • GetPipelineDescriptor(Id)
    • Methods
      • ClusterManagerTimeout(Time)
      • Id(Id)
      • MasterTimeout(Time)
    • Implements
    • Extension Methods
    Back to top Generated by DocFX