Search Results for

    Show / Hide Table of Contents

    Class CancelTasksDescriptor

    Descriptor for Cancel

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

    Inheritance
    object
    RequestBase<CancelTasksRequestParameters>
    RequestDescriptorBase<CancelTasksDescriptor, CancelTasksRequestParameters, ICancelTasksRequest>
    CancelTasksDescriptor
    Implements
    IDescriptor
    ICancelTasksRequest
    IRequest<CancelTasksRequestParameters>
    IRequest
    Inherited Members
    RequestDescriptorBase<CancelTasksDescriptor, CancelTasksRequestParameters, ICancelTasksRequest>.Self
    RequestDescriptorBase<CancelTasksDescriptor, CancelTasksRequestParameters, ICancelTasksRequest>.Assign<TValue>(TValue, Action<ICancelTasksRequest, TValue>)
    RequestDescriptorBase<CancelTasksDescriptor, CancelTasksRequestParameters, ICancelTasksRequest>.Qs(string, object)
    RequestDescriptorBase<CancelTasksDescriptor, CancelTasksRequestParameters, ICancelTasksRequest>.RequestConfiguration(Func<RequestConfigurationDescriptor, IRequestConfiguration>)
    RequestDescriptorBase<CancelTasksDescriptor, CancelTasksRequestParameters, ICancelTasksRequest>.ErrorTrace(bool?)
    RequestDescriptorBase<CancelTasksDescriptor, CancelTasksRequestParameters, ICancelTasksRequest>.FilterPath(params string[])
    RequestDescriptorBase<CancelTasksDescriptor, CancelTasksRequestParameters, ICancelTasksRequest>.FilterPath(IEnumerable<string>)
    RequestDescriptorBase<CancelTasksDescriptor, CancelTasksRequestParameters, ICancelTasksRequest>.Human(bool?)
    RequestDescriptorBase<CancelTasksDescriptor, CancelTasksRequestParameters, ICancelTasksRequest>.Pretty(bool?)
    RequestDescriptorBase<CancelTasksDescriptor, CancelTasksRequestParameters, ICancelTasksRequest>.SourceQueryString(string)
    RequestBase<CancelTasksRequestParameters>.HttpMethod
    RequestBase<CancelTasksRequestParameters>.RequestState
    RequestBase<CancelTasksRequestParameters>.ContentType
    RequestBase<CancelTasksRequestParameters>.ResolveUrl(RouteValues, IConnectionSettingsValues)
    RequestBase<CancelTasksRequestParameters>.RequestDefaults(CancelTasksRequestParameters)
    RequestBase<CancelTasksRequestParameters>.Q<TOut>(string)
    RequestBase<CancelTasksRequestParameters>.Q(string, object)
    RequestBase<CancelTasksRequestParameters>.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 CancelTasksDescriptor : RequestDescriptorBase<CancelTasksDescriptor, CancelTasksRequestParameters, ICancelTasksRequest>, IDescriptor, ICancelTasksRequest, IRequest<CancelTasksRequestParameters>, IRequest

    Constructors

    | Edit this page View Source

    CancelTasksDescriptor()

    /_tasks/_cancel

    Declaration
    public CancelTasksDescriptor()
    | Edit this page View Source

    CancelTasksDescriptor(TaskId)

    /_tasks/{task_id}/_cancel

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

    Optional, accepts null

    Methods

    | Edit this page View Source

    Actions(params string[])

    A comma-separated list of actions that should be returned. Keep empty to return all.

    Declaration
    public CancelTasksDescriptor Actions(params string[] actions)
    Parameters
    Type Name Description
    string[] actions
    Returns
    Type Description
    CancelTasksDescriptor
    | Edit this page View Source

    Nodes(params string[])

    A comma-separated list of node IDs or names used to limit the returned information. Use _local to return information from the node you're connecting to, specify the node name to get information from a specific node, or keep the parameter empty to get information from all nodes.

    Declaration
    public CancelTasksDescriptor Nodes(params string[] nodes)
    Parameters
    Type Name Description
    string[] nodes
    Returns
    Type Description
    CancelTasksDescriptor
    | Edit this page View Source

    ParentTaskId(string)

    Returns tasks with a specified parent task ID (node_id:task_number). Keep empty or set to -1 to return all.

    Declaration
    public CancelTasksDescriptor ParentTaskId(string parenttaskid)
    Parameters
    Type Name Description
    string parenttaskid
    Returns
    Type Description
    CancelTasksDescriptor
    | Edit this page View Source

    TaskId(TaskId)

    The task ID.

    Declaration
    public CancelTasksDescriptor TaskId(TaskId taskId)
    Parameters
    Type Name Description
    TaskId taskId
    Returns
    Type Description
    CancelTasksDescriptor
    | 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 CancelTasksDescriptor WaitForCompletion(bool? waitforcompletion = true)
    Parameters
    Type Name Description
    bool? waitforcompletion
    Returns
    Type Description
    CancelTasksDescriptor

    Implements

    IDescriptor
    ICancelTasksRequest
    IRequest<TParameters>
    IRequest

    Extension Methods

    SuffixExtensions.Suffix(object, string)
    • Edit this page
    • View Source
    In this article
    • Constructors
      • CancelTasksDescriptor()
      • CancelTasksDescriptor(TaskId)
    • Methods
      • Actions(params string[])
      • Nodes(params string[])
      • ParentTaskId(string)
      • TaskId(TaskId)
      • WaitForCompletion(bool?)
    • Implements
    • Extension Methods
    Back to top Generated by DocFX