Search Results for

    Show / Hide Table of Contents

    Class GetTaskRequest

    Request for GetTask

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

    Inheritance
    object
    RequestBase<GetTaskRequestParameters>
    PlainRequestBase<GetTaskRequestParameters>
    GetTaskRequest
    Implements
    IGetTaskRequest
    IRequest<GetTaskRequestParameters>
    IRequest
    Inherited Members
    PlainRequestBase<GetTaskRequestParameters>.RequestConfiguration
    PlainRequestBase<GetTaskRequestParameters>.ErrorTrace
    PlainRequestBase<GetTaskRequestParameters>.FilterPath
    PlainRequestBase<GetTaskRequestParameters>.Human
    PlainRequestBase<GetTaskRequestParameters>.Pretty
    PlainRequestBase<GetTaskRequestParameters>.SourceQueryString
    RequestBase<GetTaskRequestParameters>.HttpMethod
    RequestBase<GetTaskRequestParameters>.RequestState
    RequestBase<GetTaskRequestParameters>.ContentType
    RequestBase<GetTaskRequestParameters>.ResolveUrl(RouteValues, IConnectionSettingsValues)
    RequestBase<GetTaskRequestParameters>.RequestDefaults(GetTaskRequestParameters)
    RequestBase<GetTaskRequestParameters>.Q<TOut>(string)
    RequestBase<GetTaskRequestParameters>.Q(string, object)
    RequestBase<GetTaskRequestParameters>.SetAcceptHeader(string)
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    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

    The amount of time to wait for a response.

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

    WaitForCompletion

    Waits for the matching task to complete. When true, the request is blocked until the task has completed.

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

    Implements

    IGetTaskRequest
    IRequest<TParameters>
    IRequest

    Extension Methods

    SuffixExtensions.Suffix(object, string)
    • Edit this page
    • View Source
    In this article
    • Constructors
      • GetTaskRequest()
      • GetTaskRequest(TaskId)
    • Properties
      • Self
      • Timeout
      • WaitForCompletion
    • Implements
    • Extension Methods
    Back to top Generated by DocFX