Class LowLevelTasksNamespace

Tasks APIs.

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

Inheritance

object

NamespacedClientProxy

LowLevelTasksNamespace

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

Assembly: OpenSearch.Net.dll

Syntax

public class LowLevelTasksNamespace : NamespacedClientProxy

Methods

| Edit this page View Source

CancelAsync<TResponse>(CancelTasksRequestParameters, CancellationToken)

POST on /_tasks/_cancel

<p>https://docs.opensearch.org/latest/api-reference/tasks/cancel-tasks/</p>

Declaration

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

Parameters

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

CancelAsync<TResponse>(string, CancelTasksRequestParameters, CancellationToken)

POST on /_tasks/{task_id}/_cancel

<p>https://docs.opensearch.org/latest/api-reference/tasks/cancel-tasks/</p>

Declaration

public Task<TResponse> CancelAsync<TResponse>(string taskId, CancelTasksRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	taskId	The task ID.
CancelTasksRequestParameters	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

Cancel<TResponse>(CancelTasksRequestParameters)

POST on /_tasks/_cancel

<p>https://docs.opensearch.org/latest/api-reference/tasks/cancel-tasks/</p>

Declaration

public TResponse Cancel<TResponse>(CancelTasksRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

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

Cancel<TResponse>(string, CancelTasksRequestParameters)

POST on /_tasks/{task_id}/_cancel

<p>https://docs.opensearch.org/latest/api-reference/tasks/cancel-tasks/</p>

Declaration

public TResponse Cancel<TResponse>(string taskId, CancelTasksRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	taskId	The task ID.
CancelTasksRequestParameters	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

DeleteAsync<TResponse>(string, DeleteRequestParameters, CancellationToken)

DELETE on /_tasks/{task_id}

<p>https://docs.opensearch.org/latest/api-reference/tasks/delete-task/</p>

Declaration

public Task<TResponse> DeleteAsync<TResponse>(string taskId, DeleteRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	taskId	The ID of the stored completed task result to delete (<c>node_id:task_number</c>).
DeleteRequestParameters	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.9.0 or greater.

| Edit this page View Source

Delete<TResponse>(string, DeleteRequestParameters)

DELETE on /_tasks/{task_id}

<p>https://docs.opensearch.org/latest/api-reference/tasks/delete-task/</p>

Declaration

public TResponse Delete<TResponse>(string taskId, DeleteRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	taskId	The ID of the stored completed task result to delete (<c>node_id:task_number</c>).
DeleteRequestParameters	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.9.0 or greater.

| Edit this page View Source

GetTaskAsync<TResponse>(string, GetTaskRequestParameters, CancellationToken)

GET on /_tasks/{task_id}

<p>https://docs.opensearch.org/latest/api-reference/tasks/</p>

Declaration

public Task<TResponse> GetTaskAsync<TResponse>(string taskId, GetTaskRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	taskId	The task ID.
GetTaskRequestParameters	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

GetTask<TResponse>(string, GetTaskRequestParameters)

GET on /_tasks/{task_id}

<p>https://docs.opensearch.org/latest/api-reference/tasks/</p>

Declaration

public TResponse GetTask<TResponse>(string taskId, GetTaskRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	taskId	The task ID.
GetTaskRequestParameters	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

ListAsync<TResponse>(ListTasksRequestParameters, CancellationToken)

GET on /_tasks

<p>https://docs.opensearch.org/latest/api-reference/tasks/</p>

Declaration

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

Parameters

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

List<TResponse>(ListTasksRequestParameters)

GET on /_tasks

<p>https://docs.opensearch.org/latest/api-reference/tasks/</p>

Declaration

public TResponse List<TResponse>(ListTasksRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
ListTasksRequestParameters	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)