Class TasksNamespace

Tasks implementation.

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

Inheritance

object

NamespacedClientProxy

TasksNamespace

Implements

ITasksNamespace

Inherited Members

NamespacedClientProxy.DoCat<TRequest, TParams, TCatRecord>(TRequest)

NamespacedClientProxy.DoCatAsync<TRequest, TParams, TCatRecord>(TRequest, CancellationToken)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: OpenSearch.Client.Specification.TasksApi

Assembly: OpenSearch.Client.dll

Syntax

public class TasksNamespace : NamespacedClientProxy, ITasksNamespace

Methods

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

public CancelTasksResponse Cancel(ICancelTasksRequest request)

Parameters

Type	Name	Description
ICancelTasksRequest	request

Returns

Type	Description
CancelTasksResponse

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

public CancelTasksResponse Cancel(Func<CancelTasksDescriptor, ICancelTasksRequest> selector = null)

Parameters

Type	Name	Description
Func<CancelTasksDescriptor, ICancelTasksRequest>	selector

Returns

Type	Description
CancelTasksResponse

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

public Task<CancelTasksResponse> CancelAsync(ICancelTasksRequest request, CancellationToken ct = default)

Parameters

Type	Name	Description
ICancelTasksRequest	request
CancellationToken	ct

Returns

Type	Description
Task<CancelTasksResponse>

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

public 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>

GetTask(IGetTaskRequest)

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

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

Declaration

public GetTaskResponse GetTask(IGetTaskRequest request)

Parameters

Type	Name	Description
IGetTaskRequest	request

Returns

Type	Description
GetTaskResponse

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

public GetTaskResponse GetTask(TaskId taskId, Func<GetTaskDescriptor, IGetTaskRequest> selector = null)

Parameters

Type	Name	Description
TaskId	taskId
Func<GetTaskDescriptor, IGetTaskRequest>	selector

Returns

Type	Description
GetTaskResponse

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

public Task<GetTaskResponse> GetTaskAsync(IGetTaskRequest request, CancellationToken ct = default)

Parameters

Type	Name	Description
IGetTaskRequest	request
CancellationToken	ct

Returns

Type	Description
Task<GetTaskResponse>

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

public 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>

List(IListTasksRequest)

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

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

Declaration

public ListTasksResponse List(IListTasksRequest request)

Parameters

Type	Name	Description
IListTasksRequest	request

Returns

Type	Description
ListTasksResponse

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

public ListTasksResponse List(Func<ListTasksDescriptor, IListTasksRequest> selector = null)

Parameters

Type	Name	Description
Func<ListTasksDescriptor, IListTasksRequest>	selector

Returns

Type	Description
ListTasksResponse

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

public Task<ListTasksResponse> ListAsync(IListTasksRequest request, CancellationToken ct = default)

Parameters

Type	Name	Description
IListTasksRequest	request
CancellationToken	ct

Returns

Type	Description
Task<ListTasksResponse>

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

public 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>

Implements

ITasksNamespace

Extension Methods

SuffixExtensions.Suffix(object, string)