Class LowLevelIsmNamespace

Ism APIs.

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

Inheritance

object

NamespacedClientProxy

LowLevelIsmNamespace

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

Assembly: OpenSearch.Net.dll

Syntax

public class LowLevelIsmNamespace : NamespacedClientProxy

Methods

| Edit this page View Source

AddPolicyAsync<TResponse>(PostData, AddPolicyRequestParameters, CancellationToken)

POST on /_plugins/_ism/add

<p>https://docs.opensearch.org/latest/im-plugin/ism/api/#add-policy</p>

Declaration

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

Parameters

Type	Name	Description
PostData	body
AddPolicyRequestParameters	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

AddPolicyAsync<TResponse>(string, PostData, AddPolicyRequestParameters, CancellationToken)

POST on /_plugins/_ism/add/{index}

<p>https://docs.opensearch.org/latest/im-plugin/ism/api/#add-policy</p>

Declaration

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

Parameters

Type	Name	Description
string	index	A comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (<c></c>). To target all data streams and indexes, omit this parameter or use <c></c> or <c>_all</c>.
PostData	body
AddPolicyRequestParameters	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

AddPolicy<TResponse>(PostData, AddPolicyRequestParameters)

POST on /_plugins/_ism/add

<p>https://docs.opensearch.org/latest/im-plugin/ism/api/#add-policy</p>

Declaration

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

Parameters

Type	Name	Description
PostData	body
AddPolicyRequestParameters	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

AddPolicy<TResponse>(string, PostData, AddPolicyRequestParameters)

POST on /_plugins/_ism/add/{index}

<p>https://docs.opensearch.org/latest/im-plugin/ism/api/#add-policy</p>

Declaration

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

Parameters

Type	Name	Description
string	index	A comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (<c></c>). To target all data streams and indexes, omit this parameter or use <c></c> or <c>_all</c>.
PostData	body
AddPolicyRequestParameters	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

ChangePolicyAsync<TResponse>(PostData, ChangePolicyRequestParameters, CancellationToken)

POST on /_plugins/_ism/change_policy

<p>https://docs.opensearch.org/latest/im-plugin/ism/api/#update-managed-index-policy</p>

Declaration

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

Parameters

Type	Name	Description
PostData	body
ChangePolicyRequestParameters	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

ChangePolicyAsync<TResponse>(string, PostData, ChangePolicyRequestParameters, CancellationToken)

POST on /_plugins/_ism/change_policy/{index}

<p>https://docs.opensearch.org/latest/im-plugin/ism/api/#update-managed-index-policy</p>

Declaration

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

Parameters

Type	Name	Description
string	index	A comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (<c></c>). To target all data streams and indexes, omit this parameter or use <c></c> or <c>_all</c>.
PostData	body
ChangePolicyRequestParameters	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

ChangePolicy<TResponse>(PostData, ChangePolicyRequestParameters)

POST on /_plugins/_ism/change_policy

<p>https://docs.opensearch.org/latest/im-plugin/ism/api/#update-managed-index-policy</p>

Declaration

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

Parameters

Type	Name	Description
PostData	body
ChangePolicyRequestParameters	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

ChangePolicy<TResponse>(string, PostData, ChangePolicyRequestParameters)

POST on /_plugins/_ism/change_policy/{index}

<p>https://docs.opensearch.org/latest/im-plugin/ism/api/#update-managed-index-policy</p>

Declaration

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

Parameters

Type	Name	Description
string	index	A comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (<c></c>). To target all data streams and indexes, omit this parameter or use <c></c> or <c>_all</c>.
PostData	body
ChangePolicyRequestParameters	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

DeletePolicyAsync<TResponse>(string, DeletePolicyRequestParameters, CancellationToken)

DELETE on /_plugins/_ism/policies/{policy_id}

<p>https://docs.opensearch.org/latest/im-plugin/ism/api/#delete-policy</p>

Declaration

public Task<TResponse> DeletePolicyAsync<TResponse>(string policyId, DeletePolicyRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	policyId
DeletePolicyRequestParameters	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

DeletePolicy<TResponse>(string, DeletePolicyRequestParameters)

DELETE on /_plugins/_ism/policies/{policy_id}

<p>https://docs.opensearch.org/latest/im-plugin/ism/api/#delete-policy</p>

Declaration

public TResponse DeletePolicy<TResponse>(string policyId, DeletePolicyRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	policyId
DeletePolicyRequestParameters	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

ExistsPolicyAsync<TResponse>(string, ExistsPolicyRequestParameters, CancellationToken)

HEAD on /_plugins/_ism/policies/{policy_id}

<p>https://docs.opensearch.org/latest/im-plugin/ism/api/#get-policy</p>

Declaration

public Task<TResponse> ExistsPolicyAsync<TResponse>(string policyId, ExistsPolicyRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	policyId
ExistsPolicyRequestParameters	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

ExistsPolicy<TResponse>(string, ExistsPolicyRequestParameters)

HEAD on /_plugins/_ism/policies/{policy_id}

<p>https://docs.opensearch.org/latest/im-plugin/ism/api/#get-policy</p>

Declaration

public TResponse ExistsPolicy<TResponse>(string policyId, ExistsPolicyRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	policyId
ExistsPolicyRequestParameters	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

ExplainPolicyAsync<TResponse>(PostData, ExplainPolicyRequestParameters, CancellationToken)

POST on /_plugins/_ism/explain

<p>https://docs.opensearch.org/latest/im-plugin/ism/api/#explain-index</p>

Declaration

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

Parameters

Type	Name	Description
PostData	body
ExplainPolicyRequestParameters	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

ExplainPolicyAsync<TResponse>(string, PostData, ExplainPolicyRequestParameters, CancellationToken)

POST on /_plugins/_ism/explain/{index}

<p>https://docs.opensearch.org/latest/im-plugin/ism/api/#explain-index</p>

Declaration

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

Parameters

Type	Name	Description
string	index	A comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (<c></c>). To target all data streams and indexes, omit this parameter or use <c></c> or <c>_all</c>.
PostData	body
ExplainPolicyRequestParameters	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

ExplainPolicy<TResponse>(PostData, ExplainPolicyRequestParameters)

POST on /_plugins/_ism/explain

<p>https://docs.opensearch.org/latest/im-plugin/ism/api/#explain-index</p>

Declaration

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

Parameters

Type	Name	Description
PostData	body
ExplainPolicyRequestParameters	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

ExplainPolicy<TResponse>(string, PostData, ExplainPolicyRequestParameters)

POST on /_plugins/_ism/explain/{index}

<p>https://docs.opensearch.org/latest/im-plugin/ism/api/#explain-index</p>

Declaration

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

Parameters

Type	Name	Description
string	index	A comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (<c></c>). To target all data streams and indexes, omit this parameter or use <c></c> or <c>_all</c>.
PostData	body
ExplainPolicyRequestParameters	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

GetPoliciesAsync<TResponse>(GetPoliciesRequestParameters, CancellationToken)

GET on /_plugins/_ism/policies

<p>https://docs.opensearch.org/latest/im-plugin/ism/api/#get-policy</p>

Declaration

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

Parameters

Type	Name	Description
GetPoliciesRequestParameters	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

GetPolicies<TResponse>(GetPoliciesRequestParameters)

GET on /_plugins/_ism/policies

<p>https://docs.opensearch.org/latest/im-plugin/ism/api/#get-policy</p>

Declaration

public TResponse GetPolicies<TResponse>(GetPoliciesRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
GetPoliciesRequestParameters	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

GetPolicyAsync<TResponse>(string, GetPolicyRequestParameters, CancellationToken)

GET on /_plugins/_ism/policies/{policy_id}

<p>https://docs.opensearch.org/latest/im-plugin/ism/api/#get-policy</p>

Declaration

public Task<TResponse> GetPolicyAsync<TResponse>(string policyId, GetPolicyRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	policyId
GetPolicyRequestParameters	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

GetPolicy<TResponse>(string, GetPolicyRequestParameters)

GET on /_plugins/_ism/policies/{policy_id}

<p>https://docs.opensearch.org/latest/im-plugin/ism/api/#get-policy</p>

Declaration

public TResponse GetPolicy<TResponse>(string policyId, GetPolicyRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	policyId
GetPolicyRequestParameters	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

PutPoliciesAsync<TResponse>(PostData, PutPoliciesRequestParameters, CancellationToken)

PUT on /_plugins/_ism/policies

<p>https://docs.opensearch.org/latest/im-plugin/ism/api/#create-policy</p>

Declaration

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

Parameters

Type	Name	Description
PostData	body
PutPoliciesRequestParameters	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

PutPolicies<TResponse>(PostData, PutPoliciesRequestParameters)

PUT on /_plugins/_ism/policies

<p>https://docs.opensearch.org/latest/im-plugin/ism/api/#create-policy</p>

Declaration

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

Parameters

Type	Name	Description
PostData	body
PutPoliciesRequestParameters	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

PutPolicyAsync<TResponse>(string, PostData, PutPolicyRequestParameters, CancellationToken)

PUT on /_plugins/_ism/policies/{policy_id}

<p>https://docs.opensearch.org/latest/im-plugin/ism/api/#create-policy</p>

Declaration

public Task<TResponse> PutPolicyAsync<TResponse>(string policyId, PostData body, PutPolicyRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	policyId
PostData	body
PutPolicyRequestParameters	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

PutPolicy<TResponse>(string, PostData, PutPolicyRequestParameters)

PUT on /_plugins/_ism/policies/{policy_id}

<p>https://docs.opensearch.org/latest/im-plugin/ism/api/#create-policy</p>

Declaration

public TResponse PutPolicy<TResponse>(string policyId, PostData body, PutPolicyRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	policyId
PostData	body
PutPolicyRequestParameters	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

RefreshSearchAnalyzersAsync<TResponse>(string, RefreshSearchAnalyzersRequestParameters, CancellationToken)

POST on /_plugins/_refresh_search_analyzers/{index}

<p>https://docs.opensearch.org/latest/im-plugin/refresh-analyzer/</p>

Declaration

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

Parameters

Type	Name	Description
string	index	A comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (<c></c>). To target all data streams and indexes, omit this parameter or use <c></c> or <c>_all</c>.
RefreshSearchAnalyzersRequestParameters	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

RefreshSearchAnalyzers<TResponse>(string, RefreshSearchAnalyzersRequestParameters)

POST on /_plugins/_refresh_search_analyzers/{index}

<p>https://docs.opensearch.org/latest/im-plugin/refresh-analyzer/</p>

Declaration

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

Parameters

Type	Name	Description
string	index	A comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (<c></c>). To target all data streams and indexes, omit this parameter or use <c></c> or <c>_all</c>.
RefreshSearchAnalyzersRequestParameters	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

RemovePolicyAsync<TResponse>(RemovePolicyRequestParameters, CancellationToken)

POST on /_plugins/_ism/remove

<p>https://docs.opensearch.org/latest/im-plugin/ism/api/#remove-policy-from-index</p>

Declaration

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

Parameters

Type	Name	Description
RemovePolicyRequestParameters	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

RemovePolicyAsync<TResponse>(string, RemovePolicyRequestParameters, CancellationToken)

POST on /_plugins/_ism/remove/{index}

<p>https://docs.opensearch.org/latest/im-plugin/ism/api/#remove-policy-from-index</p>

Declaration

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

Parameters

Type	Name	Description
string	index	A comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (<c></c>). To target all data streams and indexes, omit this parameter or use <c></c> or <c>_all</c>.
RemovePolicyRequestParameters	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

RemovePolicy<TResponse>(RemovePolicyRequestParameters)

POST on /_plugins/_ism/remove

<p>https://docs.opensearch.org/latest/im-plugin/ism/api/#remove-policy-from-index</p>

Declaration

public TResponse RemovePolicy<TResponse>(RemovePolicyRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
RemovePolicyRequestParameters	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

RemovePolicy<TResponse>(string, RemovePolicyRequestParameters)

POST on /_plugins/_ism/remove/{index}

<p>https://docs.opensearch.org/latest/im-plugin/ism/api/#remove-policy-from-index</p>

Declaration

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

Parameters

Type	Name	Description
string	index	A comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (<c></c>). To target all data streams and indexes, omit this parameter or use <c></c> or <c>_all</c>.
RemovePolicyRequestParameters	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

RetryIndexAsync<TResponse>(PostData, RetryIndexRequestParameters, CancellationToken)

POST on /_plugins/_ism/retry

<p>https://docs.opensearch.org/latest/im-plugin/ism/api/#retry-failed-index</p>

Declaration

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

Parameters

Type	Name	Description
PostData	body
RetryIndexRequestParameters	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

RetryIndexAsync<TResponse>(string, PostData, RetryIndexRequestParameters, CancellationToken)

POST on /_plugins/_ism/retry/{index}

<p>https://docs.opensearch.org/latest/im-plugin/ism/api/#retry-failed-index</p>

Declaration

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

Parameters

Type	Name	Description
string	index	A comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (<c></c>). To target all data streams and indexes, omit this parameter or use <c></c> or <c>_all</c>.
PostData	body
RetryIndexRequestParameters	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

RetryIndex<TResponse>(PostData, RetryIndexRequestParameters)

POST on /_plugins/_ism/retry

<p>https://docs.opensearch.org/latest/im-plugin/ism/api/#retry-failed-index</p>

Declaration

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

Parameters

Type	Name	Description
PostData	body
RetryIndexRequestParameters	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

RetryIndex<TResponse>(string, PostData, RetryIndexRequestParameters)

POST on /_plugins/_ism/retry/{index}

<p>https://docs.opensearch.org/latest/im-plugin/ism/api/#retry-failed-index</p>

Declaration

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

Parameters

Type	Name	Description
string	index	A comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (<c></c>). To target all data streams and indexes, omit this parameter or use <c></c> or <c>_all</c>.
PostData	body
RetryIndexRequestParameters	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)