Class GetTaskRequest

Request for GetTask

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

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

Constructors

| Edit this page View Source

GetTaskRequest()

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

Declaration
protected GetTaskRequest()
| Edit this page View Source

GetTaskRequest(TaskId)

/_tasks/{task_id}

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

this parameter is required

Properties

| Edit this page View Source

Self

Declaration
protected IGetTaskRequest Self { get; }
Property Value
Type Description
IGetTaskRequest
| Edit this page View Source

Timeout

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

Declaration
public Time Timeout { get; set; }
Property Value
Type Description
Time
| Edit this page View Source

WaitForCompletion

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

Declaration
public bool? WaitForCompletion { get; set; }
Property Value
Type Description
bool?

Implements

Extension Methods