Interface IIngestNamespace

Ingest APIs.

Use the Ingest property on IOpenSearchClient.

Namespace: OpenSearch.Client.Specification.IngestApi
Assembly: OpenSearch.Client.dll
Syntax
public interface IIngestNamespace

Methods

| Edit this page View Source

DeletePipeline(IDeletePipelineRequest)

DELETE request to the ingest.delete_pipeline API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/ingest-apis/delete-ingest/
Declaration
DeletePipelineResponse DeletePipeline(IDeletePipelineRequest request)
Parameters
Type Name Description
IDeletePipelineRequest request
Returns
Type Description
DeletePipelineResponse
| Edit this page View Source

DeletePipeline(Id, Func<DeletePipelineDescriptor, IDeletePipelineRequest>)

DELETE request to the ingest.delete_pipeline API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/ingest-apis/delete-ingest/
Declaration
DeletePipelineResponse DeletePipeline(Id id, Func<DeletePipelineDescriptor, IDeletePipelineRequest> selector = null)
Parameters
Type Name Description
Id id
Func<DeletePipelineDescriptor, IDeletePipelineRequest> selector
Returns
Type Description
DeletePipelineResponse
| Edit this page View Source

DeletePipelineAsync(IDeletePipelineRequest, CancellationToken)

DELETE request to the ingest.delete_pipeline API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/ingest-apis/delete-ingest/
Declaration
Task<DeletePipelineResponse> DeletePipelineAsync(IDeletePipelineRequest request, CancellationToken ct = default)
Parameters
Type Name Description
IDeletePipelineRequest request
CancellationToken ct
Returns
Type Description
Task<DeletePipelineResponse>
| Edit this page View Source

DeletePipelineAsync(Id, Func<DeletePipelineDescriptor, IDeletePipelineRequest>, CancellationToken)

DELETE request to the ingest.delete_pipeline API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/ingest-apis/delete-ingest/
Declaration
Task<DeletePipelineResponse> DeletePipelineAsync(Id id, Func<DeletePipelineDescriptor, IDeletePipelineRequest> selector = null, CancellationToken ct = default)
Parameters
Type Name Description
Id id
Func<DeletePipelineDescriptor, IDeletePipelineRequest> selector
CancellationToken ct
Returns
Type Description
Task<DeletePipelineResponse>
| Edit this page View Source

GetPipeline(IGetPipelineRequest)

GET request to the ingest.get_pipeline API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/ingest-apis/get-ingest/
Declaration
GetPipelineResponse GetPipeline(IGetPipelineRequest request)
Parameters
Type Name Description
IGetPipelineRequest request
Returns
Type Description
GetPipelineResponse
| Edit this page View Source

GetPipeline(Func<GetPipelineDescriptor, IGetPipelineRequest>)

GET request to the ingest.get_pipeline API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/ingest-apis/get-ingest/
Declaration
GetPipelineResponse GetPipeline(Func<GetPipelineDescriptor, IGetPipelineRequest> selector = null)
Parameters
Type Name Description
Func<GetPipelineDescriptor, IGetPipelineRequest> selector
Returns
Type Description
GetPipelineResponse
| Edit this page View Source

GetPipelineAsync(IGetPipelineRequest, CancellationToken)

GET request to the ingest.get_pipeline API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/ingest-apis/get-ingest/
Declaration
Task<GetPipelineResponse> GetPipelineAsync(IGetPipelineRequest request, CancellationToken ct = default)
Parameters
Type Name Description
IGetPipelineRequest request
CancellationToken ct
Returns
Type Description
Task<GetPipelineResponse>
| Edit this page View Source

GetPipelineAsync(Func<GetPipelineDescriptor, IGetPipelineRequest>, CancellationToken)

GET request to the ingest.get_pipeline API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/ingest-apis/get-ingest/
Declaration
Task<GetPipelineResponse> GetPipelineAsync(Func<GetPipelineDescriptor, IGetPipelineRequest> selector = null, CancellationToken ct = default)
Parameters
Type Name Description
Func<GetPipelineDescriptor, IGetPipelineRequest> selector
CancellationToken ct
Returns
Type Description
Task<GetPipelineResponse>
| Edit this page View Source

GrokProcessorPatterns(IGrokProcessorPatternsRequest)

GET request to the ingest.processor_grok API, read more about this API online:

https://opensearch.org/docs/latest
Declaration
GrokProcessorPatternsResponse GrokProcessorPatterns(IGrokProcessorPatternsRequest request)
Parameters
Type Name Description
IGrokProcessorPatternsRequest request
Returns
Type Description
GrokProcessorPatternsResponse
| Edit this page View Source

GrokProcessorPatterns(Func<GrokProcessorPatternsDescriptor, IGrokProcessorPatternsRequest>)

GET request to the ingest.processor_grok API, read more about this API online:

https://opensearch.org/docs/latest
Declaration
GrokProcessorPatternsResponse GrokProcessorPatterns(Func<GrokProcessorPatternsDescriptor, IGrokProcessorPatternsRequest> selector = null)
Parameters
Type Name Description
Func<GrokProcessorPatternsDescriptor, IGrokProcessorPatternsRequest> selector
Returns
Type Description
GrokProcessorPatternsResponse
| Edit this page View Source

GrokProcessorPatternsAsync(IGrokProcessorPatternsRequest, CancellationToken)

GET request to the ingest.processor_grok API, read more about this API online:

https://opensearch.org/docs/latest
Declaration
Task<GrokProcessorPatternsResponse> GrokProcessorPatternsAsync(IGrokProcessorPatternsRequest request, CancellationToken ct = default)
Parameters
Type Name Description
IGrokProcessorPatternsRequest request
CancellationToken ct
Returns
Type Description
Task<GrokProcessorPatternsResponse>
| Edit this page View Source

GrokProcessorPatternsAsync(Func<GrokProcessorPatternsDescriptor, IGrokProcessorPatternsRequest>, CancellationToken)

GET request to the ingest.processor_grok API, read more about this API online:

https://opensearch.org/docs/latest
Declaration
Task<GrokProcessorPatternsResponse> GrokProcessorPatternsAsync(Func<GrokProcessorPatternsDescriptor, IGrokProcessorPatternsRequest> selector = null, CancellationToken ct = default)
Parameters
Type Name Description
Func<GrokProcessorPatternsDescriptor, IGrokProcessorPatternsRequest> selector
CancellationToken ct
Returns
Type Description
Task<GrokProcessorPatternsResponse>
| Edit this page View Source

PutPipeline(IPutPipelineRequest)

PUT request to the ingest.put_pipeline API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/ingest-apis/create-update-ingest/
Declaration
PutPipelineResponse PutPipeline(IPutPipelineRequest request)
Parameters
Type Name Description
IPutPipelineRequest request
Returns
Type Description
PutPipelineResponse
| Edit this page View Source

PutPipeline(Id, Func<PutPipelineDescriptor, IPutPipelineRequest>)

PUT request to the ingest.put_pipeline API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/ingest-apis/create-update-ingest/
Declaration
PutPipelineResponse PutPipeline(Id id, Func<PutPipelineDescriptor, IPutPipelineRequest> selector)
Parameters
Type Name Description
Id id
Func<PutPipelineDescriptor, IPutPipelineRequest> selector
Returns
Type Description
PutPipelineResponse
| Edit this page View Source

PutPipelineAsync(IPutPipelineRequest, CancellationToken)

PUT request to the ingest.put_pipeline API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/ingest-apis/create-update-ingest/
Declaration
Task<PutPipelineResponse> PutPipelineAsync(IPutPipelineRequest request, CancellationToken ct = default)
Parameters
Type Name Description
IPutPipelineRequest request
CancellationToken ct
Returns
Type Description
Task<PutPipelineResponse>
| Edit this page View Source

PutPipelineAsync(Id, Func<PutPipelineDescriptor, IPutPipelineRequest>, CancellationToken)

PUT request to the ingest.put_pipeline API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/ingest-apis/create-update-ingest/
Declaration
Task<PutPipelineResponse> PutPipelineAsync(Id id, Func<PutPipelineDescriptor, IPutPipelineRequest> selector, CancellationToken ct = default)
Parameters
Type Name Description
Id id
Func<PutPipelineDescriptor, IPutPipelineRequest> selector
CancellationToken ct
Returns
Type Description
Task<PutPipelineResponse>
| Edit this page View Source

SimulatePipeline(ISimulatePipelineRequest)

POST request to the ingest.simulate API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/ingest-apis/simulate-ingest/
Declaration
SimulatePipelineResponse SimulatePipeline(ISimulatePipelineRequest request)
Parameters
Type Name Description
ISimulatePipelineRequest request
Returns
Type Description
SimulatePipelineResponse
| Edit this page View Source

SimulatePipeline(Func<SimulatePipelineDescriptor, ISimulatePipelineRequest>)

POST request to the ingest.simulate API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/ingest-apis/simulate-ingest/
Declaration
SimulatePipelineResponse SimulatePipeline(Func<SimulatePipelineDescriptor, ISimulatePipelineRequest> selector = null)
Parameters
Type Name Description
Func<SimulatePipelineDescriptor, ISimulatePipelineRequest> selector
Returns
Type Description
SimulatePipelineResponse
| Edit this page View Source

SimulatePipelineAsync(ISimulatePipelineRequest, CancellationToken)

POST request to the ingest.simulate API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/ingest-apis/simulate-ingest/
Declaration
Task<SimulatePipelineResponse> SimulatePipelineAsync(ISimulatePipelineRequest request, CancellationToken ct = default)
Parameters
Type Name Description
ISimulatePipelineRequest request
CancellationToken ct
Returns
Type Description
Task<SimulatePipelineResponse>
| Edit this page View Source

SimulatePipelineAsync(Func<SimulatePipelineDescriptor, ISimulatePipelineRequest>, CancellationToken)

POST request to the ingest.simulate API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/ingest-apis/simulate-ingest/
Declaration
Task<SimulatePipelineResponse> SimulatePipelineAsync(Func<SimulatePipelineDescriptor, ISimulatePipelineRequest> selector = null, CancellationToken ct = default)
Parameters
Type Name Description
Func<SimulatePipelineDescriptor, ISimulatePipelineRequest> selector
CancellationToken ct
Returns
Type Description
Task<SimulatePipelineResponse>

Extension Methods