Class GetPipelineDescriptor
Descriptor for GetPipeline
https://opensearch.org/docs/latest/api-reference/ingest-apis/get-ingest/
Inheritance
GetPipelineDescriptor
Inherited Members
Namespace: OpenSearch .Client
Assembly: OpenSearch.Client.dll
Syntax
public class GetPipelineDescriptor : RequestDescriptorBase<GetPipelineDescriptor, GetPipelineRequestParameters, IGetPipelineRequest>, IDescriptor, IGetPipelineRequest, IRequest<GetPipelineRequestParameters>, IRequestConstructors
| Edit this page View SourceGetPipelineDescriptor()
/_ingest/pipeline
Declaration
public GetPipelineDescriptor()GetPipelineDescriptor(Id)
/_ingest/pipeline/{id}
Declaration
public GetPipelineDescriptor(Id id)Parameters
| Type | Name | Description |
|---|---|---|
| Id | id | Optional, accepts null |
Methods
| Edit this page View SourceClusterManagerTimeout(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 |
|---|---|
| Get |
Remarks
Supported by OpenSearch servers of version 2.0.0 or greater.
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 |
|---|---|
| Get |
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 |
|---|---|
| Get |