Search Results for

    Show / Hide Table of Contents

    Class GetIndexDescriptor

    Descriptor for Get

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

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

    Constructors

    | Edit this page View Source

    GetIndexDescriptor()

    Used for serialization purposes, making sure we have a parameterless constructor

    Declaration
    protected GetIndexDescriptor()
    | Edit this page View Source

    GetIndexDescriptor(Indices)

    /{index}

    Declaration
    public GetIndexDescriptor(Indices index)
    Parameters
    Type Name Description
    Indices index

    this parameter is required

    Methods

    | Edit this page View Source

    AllIndices()

    A shortcut into calling Index(Indices.All)

    Declaration
    public GetIndexDescriptor AllIndices()
    Returns
    Type Description
    GetIndexDescriptor
    | Edit this page View Source

    AllowNoIndices(bool?)

    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. For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar.

    Declaration
    public GetIndexDescriptor AllowNoIndices(bool? allownoindices = true)
    Parameters
    Type Name Description
    bool? allownoindices
    Returns
    Type Description
    GetIndexDescriptor
    | Edit this page View Source

    ClusterManagerTimeout(Time)

    Operation timeout for connection to cluster-manager node.

    Declaration
    public GetIndexDescriptor ClusterManagerTimeout(Time clustermanagertimeout)
    Parameters
    Type Name Description
    Time clustermanagertimeout
    Returns
    Type Description
    GetIndexDescriptor
    Remarks

    Supported by OpenSearch servers of version 2.0.0 or greater.

    | Edit this page View Source

    ExpandWildcards(ExpandWildcards?)

    Type of index that wildcard expressions 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.

    Declaration
    public GetIndexDescriptor ExpandWildcards(ExpandWildcards? expandwildcards)
    Parameters
    Type Name Description
    ExpandWildcards? expandwildcards
    Returns
    Type Description
    GetIndexDescriptor
    | Edit this page View Source

    FlatSettings(bool?)

    If true, returns settings in flat format.

    Declaration
    public GetIndexDescriptor FlatSettings(bool? flatsettings = true)
    Parameters
    Type Name Description
    bool? flatsettings
    Returns
    Type Description
    GetIndexDescriptor
    | Edit this page View Source

    IgnoreUnavailable(bool?)

    If false, requests that target a missing index return an error.

    Declaration
    public GetIndexDescriptor IgnoreUnavailable(bool? ignoreunavailable = true)
    Parameters
    Type Name Description
    bool? ignoreunavailable
    Returns
    Type Description
    GetIndexDescriptor
    | Edit this page View Source

    IncludeDefaults(bool?)

    If true, return all default settings in the response.

    Declaration
    public GetIndexDescriptor IncludeDefaults(bool? includedefaults = true)
    Parameters
    Type Name Description
    bool? includedefaults
    Returns
    Type Description
    GetIndexDescriptor
    | Edit this page View Source

    IncludeTypeName(bool?)

    Whether to add the type name to the response (default: false)

    Declaration
    public GetIndexDescriptor IncludeTypeName(bool? includetypename = true)
    Parameters
    Type Name Description
    bool? includetypename
    Returns
    Type Description
    GetIndexDescriptor
    Remarks

    Deprecated as of OpenSearch 2.0

    | Edit this page View Source

    Index(Indices)

    A comma-separated list of data streams, indexes, and index aliases used to limit the request. Wildcard expressions (*) are supported.

    Declaration
    public GetIndexDescriptor Index(Indices index)
    Parameters
    Type Name Description
    Indices index
    Returns
    Type Description
    GetIndexDescriptor
    | Edit this page View Source

    Index<TOther>()

    a shortcut into calling Index(typeof(TOther))

    Declaration
    public GetIndexDescriptor Index<TOther>() where TOther : class
    Returns
    Type Description
    GetIndexDescriptor
    Type Parameters
    Name Description
    TOther
    | Edit this page View Source

    Local(bool?)

    If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the cluster-manager node.

    Declaration
    public GetIndexDescriptor Local(bool? local = true)
    Parameters
    Type Name Description
    bool? local
    Returns
    Type Description
    GetIndexDescriptor
    | Edit this page View Source

    MasterTimeout(Time)

    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 GetIndexDescriptor MasterTimeout(Time mastertimeout)
    Parameters
    Type Name Description
    Time mastertimeout
    Returns
    Type Description
    GetIndexDescriptor

    Implements

    IDescriptor
    IGetIndexRequest
    IRequest<TParameters>
    IRequest

    Extension Methods

    SuffixExtensions.Suffix(object, string)
    • Edit this page
    • View Source
    In this article
    • Constructors
      • GetIndexDescriptor()
      • GetIndexDescriptor(Indices)
    • Methods
      • AllIndices()
      • AllowNoIndices(bool?)
      • ClusterManagerTimeout(Time)
      • ExpandWildcards(ExpandWildcards?)
      • FlatSettings(bool?)
      • IgnoreUnavailable(bool?)
      • IncludeDefaults(bool?)
      • IncludeTypeName(bool?)
      • Index(Indices)
      • Index<TOther>()
      • Local(bool?)
      • MasterTimeout(Time)
    • Implements
    • Extension Methods
    Back to top Generated by DocFX