Search Results for

    Show / Hide Table of Contents

    Class GetTaskRequestParameters

    Request options for GetTask

    <p>https://docs.opensearch.org/latest/api-reference/tasks/</p>
    
    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>.SetAcceptHeader(Enum)
    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

    | Edit this page View Source

    DefaultHttpMethod

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

    OperationName

    The OpenSearch REST API operation name this request maps to (for example search or indices.create), used as the OpenTelemetry span name and db.operation tag. null for requests that do not correspond to a named API operation.

    Declaration
    public override string OperationName { get; }
    Property Value
    Type Description
    string
    Overrides
    RequestParameters<GetTaskRequestParameters>.OperationName
    | Edit this page View Source

    SupportsBody

    Declaration
    public override bool SupportsBody { get; }
    Property Value
    Type Description
    bool
    Overrides
    RequestParameters<GetTaskRequestParameters>.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
    Back to top Generated by DocFX