Class GetTaskDescriptor

Descriptor for GetTask

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

Inheritance
object
RequestBase<GetTaskRequestParameters>
RequestDescriptorBase<GetTaskDescriptor, GetTaskRequestParameters, IGetTaskRequest>
GetTaskDescriptor
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class GetTaskDescriptor : RequestDescriptorBase<GetTaskDescriptor, GetTaskRequestParameters, IGetTaskRequest>, IDescriptor, IGetTaskRequest, IRequest<GetTaskRequestParameters>, IRequest

Constructors

| Edit this page View Source

GetTaskDescriptor()

Used for serialization purposes, making sure we have a parameterless constructor

Declaration
protected GetTaskDescriptor()
| Edit this page View Source

GetTaskDescriptor(TaskId)

/_tasks/{task_id}

Declaration
public GetTaskDescriptor(TaskId taskId)
Parameters
Type Name Description
TaskId taskId

this parameter is required

Methods

| Edit this page View Source

Timeout(Time)

Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

Declaration
public GetTaskDescriptor Timeout(Time timeout)
Parameters
Type Name Description
Time timeout
Returns
Type Description
GetTaskDescriptor
| Edit this page View Source

WaitForCompletion(bool?)

If true, the request blocks until the task has completed.

Declaration
public GetTaskDescriptor WaitForCompletion(bool? waitforcompletion = true)
Parameters
Type Name Description
bool? waitforcompletion
Returns
Type Description
GetTaskDescriptor

Implements

Extension Methods