Interface ITasksNamespace

Tasks APIs.

Use the Tasks property on IOpenSearchClient.

Namespace: OpenSearch.Client.Specification.TasksApi
Assembly: OpenSearch.Client.dll
Syntax
public interface ITasksNamespace

Methods

| Edit this page View Source

Cancel(ICancelTasksRequest)

POST request to the tasks.cancel API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/tasks/#task-canceling
Declaration
CancelTasksResponse Cancel(ICancelTasksRequest request)
Parameters
Type Name Description
ICancelTasksRequest request
Returns
Type Description
CancelTasksResponse
| Edit this page View Source

Cancel(Func<CancelTasksDescriptor, ICancelTasksRequest>)

POST request to the tasks.cancel API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/tasks/#task-canceling
Declaration
CancelTasksResponse Cancel(Func<CancelTasksDescriptor, ICancelTasksRequest> selector = null)
Parameters
Type Name Description
Func<CancelTasksDescriptor, ICancelTasksRequest> selector
Returns
Type Description
CancelTasksResponse
| Edit this page View Source

CancelAsync(ICancelTasksRequest, CancellationToken)

POST request to the tasks.cancel API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/tasks/#task-canceling
Declaration
Task<CancelTasksResponse> CancelAsync(ICancelTasksRequest request, CancellationToken ct = default)
Parameters
Type Name Description
ICancelTasksRequest request
CancellationToken ct
Returns
Type Description
Task<CancelTasksResponse>
| Edit this page View Source

CancelAsync(Func<CancelTasksDescriptor, ICancelTasksRequest>, CancellationToken)

POST request to the tasks.cancel API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/tasks/#task-canceling
Declaration
Task<CancelTasksResponse> CancelAsync(Func<CancelTasksDescriptor, ICancelTasksRequest> selector = null, CancellationToken ct = default)
Parameters
Type Name Description
Func<CancelTasksDescriptor, ICancelTasksRequest> selector
CancellationToken ct
Returns
Type Description
Task<CancelTasksResponse>
| Edit this page View Source

GetTask(IGetTaskRequest)

GET request to the tasks.get API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/tasks/
Declaration
GetTaskResponse GetTask(IGetTaskRequest request)
Parameters
Type Name Description
IGetTaskRequest request
Returns
Type Description
GetTaskResponse
| Edit this page View Source

GetTask(TaskId, Func<GetTaskDescriptor, IGetTaskRequest>)

GET request to the tasks.get API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/tasks/
Declaration
GetTaskResponse GetTask(TaskId taskId, Func<GetTaskDescriptor, IGetTaskRequest> selector = null)
Parameters
Type Name Description
TaskId taskId
Func<GetTaskDescriptor, IGetTaskRequest> selector
Returns
Type Description
GetTaskResponse
| Edit this page View Source

GetTaskAsync(IGetTaskRequest, CancellationToken)

GET request to the tasks.get API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/tasks/
Declaration
Task<GetTaskResponse> GetTaskAsync(IGetTaskRequest request, CancellationToken ct = default)
Parameters
Type Name Description
IGetTaskRequest request
CancellationToken ct
Returns
Type Description
Task<GetTaskResponse>
| Edit this page View Source

GetTaskAsync(TaskId, Func<GetTaskDescriptor, IGetTaskRequest>, CancellationToken)

GET request to the tasks.get API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/tasks/
Declaration
Task<GetTaskResponse> GetTaskAsync(TaskId taskId, Func<GetTaskDescriptor, IGetTaskRequest> selector = null, CancellationToken ct = default)
Parameters
Type Name Description
TaskId taskId
Func<GetTaskDescriptor, IGetTaskRequest> selector
CancellationToken ct
Returns
Type Description
Task<GetTaskResponse>
| Edit this page View Source

List(IListTasksRequest)

GET request to the tasks.list API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/tasks/
Declaration
ListTasksResponse List(IListTasksRequest request)
Parameters
Type Name Description
IListTasksRequest request
Returns
Type Description
ListTasksResponse
| Edit this page View Source

List(Func<ListTasksDescriptor, IListTasksRequest>)

GET request to the tasks.list API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/tasks/
Declaration
ListTasksResponse List(Func<ListTasksDescriptor, IListTasksRequest> selector = null)
Parameters
Type Name Description
Func<ListTasksDescriptor, IListTasksRequest> selector
Returns
Type Description
ListTasksResponse
| Edit this page View Source

ListAsync(IListTasksRequest, CancellationToken)

GET request to the tasks.list API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/tasks/
Declaration
Task<ListTasksResponse> ListAsync(IListTasksRequest request, CancellationToken ct = default)
Parameters
Type Name Description
IListTasksRequest request
CancellationToken ct
Returns
Type Description
Task<ListTasksResponse>
| Edit this page View Source

ListAsync(Func<ListTasksDescriptor, IListTasksRequest>, CancellationToken)

GET request to the tasks.list API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/tasks/
Declaration
Task<ListTasksResponse> ListAsync(Func<ListTasksDescriptor, IListTasksRequest> selector = null, CancellationToken ct = default)
Parameters
Type Name Description
Func<ListTasksDescriptor, IListTasksRequest> selector
CancellationToken ct
Returns
Type Description
Task<ListTasksResponse>

Extension Methods