Search Results for

    Show / Hide Table of Contents

    Class OpenIndexRequestParameters

    Request options for Open

    https://opensearch.org/docs/latest/api-reference/index-apis/open-index/

    Inheritance
    object
    RequestParameters<OpenIndexRequestParameters>
    OpenIndexRequestParameters
    Implements
    IRequestParameters
    Inherited Members
    RequestParameters<OpenIndexRequestParameters>.CustomResponseBuilder
    RequestParameters<OpenIndexRequestParameters>.QueryString
    RequestParameters<OpenIndexRequestParameters>.RequestConfiguration
    RequestParameters<OpenIndexRequestParameters>.ContainsQueryString(string)
    RequestParameters<OpenIndexRequestParameters>.GetQueryStringValue<TOut>(string)
    RequestParameters<OpenIndexRequestParameters>.GetResolvedQueryStringValue(string, IConnectionConfigurationValues)
    RequestParameters<OpenIndexRequestParameters>.SetQueryString(string, object)
    RequestParameters<OpenIndexRequestParameters>.Q<TOut>(string)
    RequestParameters<OpenIndexRequestParameters>.Q(string, object)
    RequestParameters<OpenIndexRequestParameters>.SetAcceptHeader(string)
    RequestParameters<OpenIndexRequestParameters>.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.IndicesApi
    Assembly: OpenSearch.Net.dll
    Syntax
    public class OpenIndexRequestParameters : RequestParameters<OpenIndexRequestParameters>, IRequestParameters

    Properties

    | Edit this page View Source

    AllowNoIndices

    If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indexes. This behavior applies even if the request targets other open indexes.

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

    ClusterManagerTimeout

    Operation timeout for connection to cluster-manager node.

    Declaration
    public TimeSpan ClusterManagerTimeout { get; set; }
    Property Value
    Type Description
    TimeSpan
    Remarks

    Supported by OpenSearch servers of version 2.0.0 or greater.

    | Edit this page View Source

    DefaultHttpMethod

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

    ExpandWildcards

    Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as open,hidden. Valid values are: all, open, closed, hidden, none.

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

    IgnoreUnavailable

    If false, the request returns an error if it targets a missing or closed index.

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

    MasterTimeout

    Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error.

    Declaration
    [Obsolete("Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead.")]
    public TimeSpan MasterTimeout { get; set; }
    Property Value
    Type Description
    TimeSpan
    | Edit this page View Source

    SupportsBody

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

    TaskExecutionTimeout

    Explicit task execution timeout, only useful when wait_for_completion is false, defaults to 1h.

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

    Timeout

    Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

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

    WaitForActiveShards

    The number of shard copies that must be active before proceeding with the operation. Set to all or any positive integer up to the total number of shards in the index (number_of_replicas+1).

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

    WaitForCompletion

    Should this request wait until the operation has completed before returning.

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

    Supported by OpenSearch servers of version 2.7.0 or greater.

    Implements

    IRequestParameters

    Extension Methods

    SuffixExtensions.Suffix(object, string)
    • Edit this page
    • View Source
    In this article
    • Properties
      • AllowNoIndices
      • ClusterManagerTimeout
      • DefaultHttpMethod
      • ExpandWildcards
      • IgnoreUnavailable
      • MasterTimeout
      • SupportsBody
      • TaskExecutionTimeout
      • Timeout
      • WaitForActiveShards
      • WaitForCompletion
    • Implements
    • Extension Methods
    Back to top Generated by DocFX