Class LowLevelIngestionNamespace

Ingestion APIs.

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

Inheritance

object

NamespacedClientProxy

LowLevelIngestionNamespace

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.IngestionApi

Assembly: OpenSearch.Net.dll

Syntax

public class LowLevelIngestionNamespace : NamespacedClientProxy

Methods

GetStateAsync<TResponse>(string, GetStateRequestParameters, CancellationToken)

GET on /{index}/ingestion/_state

https://docs.opensearch.org/docs/latest/api-reference/document-apis/pull-based-ingestion-management/

Declaration

public Task<TResponse> GetStateAsync<TResponse>(string index, GetStateRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	index	Index for which ingestion state should be retrieved.
GetStateRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 3.1.0 or greater.

GetState<TResponse>(string, GetStateRequestParameters)

GET on /{index}/ingestion/_state

https://docs.opensearch.org/docs/latest/api-reference/document-apis/pull-based-ingestion-management/

Declaration

public TResponse GetState<TResponse>(string index, GetStateRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	index	Index for which ingestion state should be retrieved.
GetStateRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 3.1.0 or greater.

PauseAsync<TResponse>(string, PauseRequestParameters, CancellationToken)

POST on /{index}/ingestion/_pause

https://docs.opensearch.org/docs/latest/api-reference/document-apis/pull-based-ingestion-management/

Declaration

public Task<TResponse> PauseAsync<TResponse>(string index, PauseRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	index	Index for which ingestion should be paused.
PauseRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 3.1.0 or greater.

Pause<TResponse>(string, PauseRequestParameters)

POST on /{index}/ingestion/_pause

https://docs.opensearch.org/docs/latest/api-reference/document-apis/pull-based-ingestion-management/

Declaration

public TResponse Pause<TResponse>(string index, PauseRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	index	Index for which ingestion should be paused.
PauseRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 3.1.0 or greater.

ResumeAsync<TResponse>(string, PostData, ResumeRequestParameters, CancellationToken)

POST on /{index}/ingestion/_resume

https://docs.opensearch.org/docs/latest/api-reference/document-apis/pull-based-ingestion-management/

Declaration

public Task<TResponse> ResumeAsync<TResponse>(string index, PostData body, ResumeRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	index	Index for which ingestion should be resumed.
PostData	body
ResumeRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 3.1.0 or greater.

Resume<TResponse>(string, PostData, ResumeRequestParameters)

POST on /{index}/ingestion/_resume

https://docs.opensearch.org/docs/latest/api-reference/document-apis/pull-based-ingestion-management/

Declaration

public TResponse Resume<TResponse>(string index, PostData body, ResumeRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	index	Index for which ingestion should be resumed.
PostData	body
ResumeRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 3.1.0 or greater.

Extension Methods

SuffixExtensions.Suffix(object, string)