Class GetTaskRequestParameters

Request options for GetTask

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

Inheritance

object

RequestParameters<GetTaskRequestParameters>

GetTaskRequestParameters

Implements

IRequestParameters

Inherited Members

RequestParameters<GetTaskRequestParameters>.CustomResponseBuilder

RequestParameters<GetTaskRequestParameters>.QueryString

RequestParameters<GetTaskRequestParameters>.RequestConfiguration

RequestParameters<GetTaskRequestParameters>.ContainsQueryString(string)

RequestParameters<GetTaskRequestParameters>.GetQueryStringValue<TOut>(string)

RequestParameters<GetTaskRequestParameters>.GetResolvedQueryStringValue(string, IConnectionConfigurationValues)

RequestParameters<GetTaskRequestParameters>.SetQueryString(string, object)

RequestParameters<GetTaskRequestParameters>.Q<TOut>(string)

RequestParameters<GetTaskRequestParameters>.Q(string, object)

RequestParameters<GetTaskRequestParameters>.SetAcceptHeader(string)

RequestParameters<GetTaskRequestParameters>.AcceptHeaderFromFormat(string)

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 GetTaskRequestParameters : RequestParameters<GetTaskRequestParameters>, IRequestParameters

Properties

DefaultHttpMethod

Declaration

public override HttpMethod DefaultHttpMethod { get; }

Property Value

Type	Description
HttpMethod

Overrides

RequestParameters<GetTaskRequestParameters>.DefaultHttpMethod

SupportsBody

Declaration

public override bool SupportsBody { get; }

Property Value

Type	Description
bool

Overrides

RequestParameters<GetTaskRequestParameters>.SupportsBody

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 TimeSpan Timeout { get; set; }

Property Value

Type	Description
TimeSpan

WaitForCompletion

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

Declaration

public bool? WaitForCompletion { get; set; }

Property Value

Type	Description
bool?

Implements

IRequestParameters

Extension Methods

SuffixExtensions.Suffix(object, string)