Class LowLevelIngestNamespace

Ingest APIs.

Not intended to be instantiated directly. Use the Ingest property on IOpenSearchLowLevelClient.

Inheritance

object

NamespacedClientProxy

LowLevelIngestNamespace

Inherited Members

NamespacedClientProxy.DoRequest<TResponse>(HttpMethod, string, PostData, IRequestParameters)

NamespacedClientProxy.DoRequestAsync<TResponse>(HttpMethod, string, CancellationToken, PostData, IRequestParameters)

NamespacedClientProxy.Url(FormattableString)

NamespacedClientProxy.RequestParams<TRequestParams>(TRequestParams, string)

NamespacedClientProxy.RequestParams<TRequestParams>(TRequestParams)

NamespacedClientProxy.ContentType

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: OpenSearch.Net.Specification.IngestApi

Assembly: OpenSearch.Net.dll

Syntax

public class LowLevelIngestNamespace : NamespacedClientProxy

Methods

| Edit this page View Source

DeletePipelineAsync<TResponse>(string, DeletePipelineRequestParameters, CancellationToken)

DELETE on /_ingest/pipeline/{id}

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

Declaration

public Task<TResponse> DeletePipelineAsync<TResponse>(string id, DeletePipelineRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	id	Pipeline ID or wildcard expression of pipeline IDs used to limit the request. To delete all ingest pipelines in a cluster, use a value of `*`.
DeletePipelineRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

DeletePipeline<TResponse>(string, DeletePipelineRequestParameters)

DELETE on /_ingest/pipeline/{id}

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

Declaration

public TResponse DeletePipeline<TResponse>(string id, DeletePipelineRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	id	Pipeline ID or wildcard expression of pipeline IDs used to limit the request. To delete all ingest pipelines in a cluster, use a value of `*`.
DeletePipelineRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

| Edit this page View Source

GetPipelineAsync<TResponse>(GetPipelineRequestParameters, CancellationToken)

GET on /_ingest/pipeline

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

Declaration

public Task<TResponse> GetPipelineAsync<TResponse>(GetPipelineRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
GetPipelineRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

GetPipelineAsync<TResponse>(string, GetPipelineRequestParameters, CancellationToken)

GET on /_ingest/pipeline/{id}

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

Declaration

public Task<TResponse> GetPipelineAsync<TResponse>(string id, GetPipelineRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	id	Comma-separated list of pipeline IDs to retrieve. Wildcard (``) expressions are supported. To get all ingest pipelines, omit this parameter or use ``.
GetPipelineRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

GetPipeline<TResponse>(GetPipelineRequestParameters)

GET on /_ingest/pipeline

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

Declaration

public TResponse GetPipeline<TResponse>(GetPipelineRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
GetPipelineRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

| Edit this page View Source

GetPipeline<TResponse>(string, GetPipelineRequestParameters)

GET on /_ingest/pipeline/{id}

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

Declaration

public TResponse GetPipeline<TResponse>(string id, GetPipelineRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	id	Comma-separated list of pipeline IDs to retrieve. Wildcard (``) expressions are supported. To get all ingest pipelines, omit this parameter or use ``.
GetPipelineRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

| Edit this page View Source

GrokProcessorPatternsAsync<TResponse>(GrokProcessorPatternsRequestParameters, CancellationToken)

GET on /_ingest/processor/grok

https://opensearch.org/docs/latest

Declaration

public Task<TResponse> GrokProcessorPatternsAsync<TResponse>(GrokProcessorPatternsRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
GrokProcessorPatternsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

GrokProcessorPatterns<TResponse>(GrokProcessorPatternsRequestParameters)

GET on /_ingest/processor/grok

https://opensearch.org/docs/latest

Declaration

public TResponse GrokProcessorPatterns<TResponse>(GrokProcessorPatternsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
GrokProcessorPatternsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

| Edit this page View Source

PutPipelineAsync<TResponse>(string, PostData, PutPipelineRequestParameters, CancellationToken)

PUT on /_ingest/pipeline/{id}

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

Declaration

public Task<TResponse> PutPipelineAsync<TResponse>(string id, PostData body, PutPipelineRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	id	ID of the ingest pipeline to create or update.
PostData	body	The ingest definition.
PutPipelineRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

PutPipeline<TResponse>(string, PostData, PutPipelineRequestParameters)

PUT on /_ingest/pipeline/{id}

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

Declaration

public TResponse PutPipeline<TResponse>(string id, PostData body, PutPipelineRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	id	ID of the ingest pipeline to create or update.
PostData	body	The ingest definition.
PutPipelineRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

| Edit this page View Source

SimulatePipelineAsync<TResponse>(PostData, SimulatePipelineRequestParameters, CancellationToken)

POST on /_ingest/pipeline/_simulate

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

Declaration

public Task<TResponse> SimulatePipelineAsync<TResponse>(PostData body, SimulatePipelineRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
PostData	body	The simulate definition.
SimulatePipelineRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

SimulatePipelineAsync<TResponse>(string, PostData, SimulatePipelineRequestParameters, CancellationToken)

POST on /_ingest/pipeline/{id}/_simulate

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

Declaration

public Task<TResponse> SimulatePipelineAsync<TResponse>(string id, PostData body, SimulatePipelineRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	id	Pipeline to test. If you don't specify a `pipeline` in the request body, this parameter is required.
PostData	body	The simulate definition.
SimulatePipelineRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

SimulatePipeline<TResponse>(PostData, SimulatePipelineRequestParameters)

POST on /_ingest/pipeline/_simulate

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

Declaration

public TResponse SimulatePipeline<TResponse>(PostData body, SimulatePipelineRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
PostData	body	The simulate definition.
SimulatePipelineRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

| Edit this page View Source

SimulatePipeline<TResponse>(string, PostData, SimulatePipelineRequestParameters)

POST on /_ingest/pipeline/{id}/_simulate

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

Declaration

public TResponse SimulatePipeline<TResponse>(string id, PostData body, SimulatePipelineRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	id	Pipeline to test. If you don't specify a `pipeline` in the request body, this parameter is required.
PostData	body	The simulate definition.
SimulatePipelineRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Extension Methods

SuffixExtensions.Suffix(object, string)