Search Results for

    Show / Hide Table of Contents

    Class ListTasksRequestParameters

    Request options for List

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

    Inheritance
    object
    RequestParameters<ListTasksRequestParameters>
    ListTasksRequestParameters
    Implements
    IRequestParameters
    Inherited Members
    RequestParameters<ListTasksRequestParameters>.CustomResponseBuilder
    RequestParameters<ListTasksRequestParameters>.QueryString
    RequestParameters<ListTasksRequestParameters>.RequestConfiguration
    RequestParameters<ListTasksRequestParameters>.ContainsQueryString(string)
    RequestParameters<ListTasksRequestParameters>.GetQueryStringValue<TOut>(string)
    RequestParameters<ListTasksRequestParameters>.GetResolvedQueryStringValue(string, IConnectionConfigurationValues)
    RequestParameters<ListTasksRequestParameters>.SetQueryString(string, object)
    RequestParameters<ListTasksRequestParameters>.Q<TOut>(string)
    RequestParameters<ListTasksRequestParameters>.Q(string, object)
    RequestParameters<ListTasksRequestParameters>.SetAcceptHeader(string)
    RequestParameters<ListTasksRequestParameters>.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 ListTasksRequestParameters : RequestParameters<ListTasksRequestParameters>, IRequestParameters

    Properties

    | Edit this page View Source

    Actions

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

    Declaration
    public string[] Actions { get; set; }
    Property Value
    Type Description
    string[]
    | Edit this page View Source

    DefaultHttpMethod

    Declaration
    public override HttpMethod DefaultHttpMethod { get; }
    Property Value
    Type Description
    HttpMethod
    Overrides
    RequestParameters<ListTasksRequestParameters>.DefaultHttpMethod
    | Edit this page View Source

    Detailed

    When true, the response includes detailed information about shard recoveries.

    Declaration
    public bool? Detailed { get; set; }
    Property Value
    Type Description
    bool?
    | Edit this page View Source

    GroupBy

    Groups tasks by parent/child relationships or nodes.

    Declaration
    public TasksGroupBy? GroupBy { get; set; }
    Property Value
    Type Description
    TasksGroupBy?
    | Edit this page View Source

    Nodes

    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 string[] Nodes { get; set; }
    Property Value
    Type Description
    string[]
    | Edit this page View Source

    ParentTaskId

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

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

    SupportsBody

    Declaration
    public override bool SupportsBody { get; }
    Property Value
    Type Description
    bool
    Overrides
    RequestParameters<ListTasksRequestParameters>.SupportsBody
    | Edit this page View Source

    Timeout

    The amount of time to wait for a response.

    Declaration
    public TimeSpan Timeout { get; set; }
    Property Value
    Type Description
    TimeSpan
    | 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

    IRequestParameters

    Extension Methods

    SuffixExtensions.Suffix(object, string)
    • Edit this page
    • View Source
    In this article
    • Properties
      • Actions
      • DefaultHttpMethod
      • Detailed
      • GroupBy
      • Nodes
      • ParentTaskId
      • SupportsBody
      • Timeout
      • WaitForCompletion
    • Implements
    • Extension Methods
    Back to top Generated by DocFX