Search Results for

    Show / Hide Table of Contents

    Class GetTaskDescriptor

    Descriptor for GetTask

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

    Inheritance
    object
    RequestBase<GetTaskRequestParameters>
    RequestDescriptorBase<GetTaskDescriptor, GetTaskRequestParameters, IGetTaskRequest>
    GetTaskDescriptor
    Implements
    IDescriptor
    IGetTaskRequest
    IRequest<GetTaskRequestParameters>
    IRequest
    Inherited Members
    RequestDescriptorBase<GetTaskDescriptor, GetTaskRequestParameters, IGetTaskRequest>.Self
    RequestDescriptorBase<GetTaskDescriptor, GetTaskRequestParameters, IGetTaskRequest>.Assign<TValue>(TValue, Action<IGetTaskRequest, TValue>)
    RequestDescriptorBase<GetTaskDescriptor, GetTaskRequestParameters, IGetTaskRequest>.Qs(string, object)
    RequestDescriptorBase<GetTaskDescriptor, GetTaskRequestParameters, IGetTaskRequest>.RequestConfiguration(Func<RequestConfigurationDescriptor, IRequestConfiguration>)
    RequestDescriptorBase<GetTaskDescriptor, GetTaskRequestParameters, IGetTaskRequest>.ErrorTrace(bool?)
    RequestDescriptorBase<GetTaskDescriptor, GetTaskRequestParameters, IGetTaskRequest>.FilterPath(params string[])
    RequestDescriptorBase<GetTaskDescriptor, GetTaskRequestParameters, IGetTaskRequest>.FilterPath(IEnumerable<string>)
    RequestDescriptorBase<GetTaskDescriptor, GetTaskRequestParameters, IGetTaskRequest>.Human(bool?)
    RequestDescriptorBase<GetTaskDescriptor, GetTaskRequestParameters, IGetTaskRequest>.Pretty(bool?)
    RequestDescriptorBase<GetTaskDescriptor, GetTaskRequestParameters, IGetTaskRequest>.SourceQueryString(string)
    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 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)

    The amount of time to wait for a response.

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

    WaitForCompletion(bool?)

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

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

    Implements

    IDescriptor
    IGetTaskRequest
    IRequest<TParameters>
    IRequest

    Extension Methods

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