Search Results for

    Show / Hide Table of Contents

    Class IndicesRequestParameters

    Request options for Indices

    https://opensearch.org/docs/latest/api-reference/list/list-indices/

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

    Properties

    | Edit this page View Source

    Bytes

    The unit used to display byte values.

    Declaration
    public ByteUnit? Bytes { get; set; }
    Property Value
    Type Description
    ByteUnit?
    | 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<IndicesRequestParameters>.DefaultHttpMethod
    | Edit this page View Source

    ExpandWildcards

    The type of index that wildcard patterns can match.

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

    Format

    A short version of the Accept header, such as JSON, YAML.

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

    Headers

    Comma-separated list of column names to display.

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

    Health

    The health status used to limit returned indexes. By default, the response includes indexes of any health status.

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

    Help

    Return help information.

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

    IncludeUnloadedSegments

    If true, the response includes information from segments that are not loaded into memory.

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

    Local

    Return local information, do not retrieve the state from cluster-manager node.

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

    MasterTimeout

    Operation timeout for connection to cluster-manager node.

    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

    NextToken

    Token to retrieve next page of indexes.

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

    Pri

    If true, the response only includes information from primary shards.

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

    Size

    Maximum number of indexes to be displayed in a page.

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

    Sort

    Defines order in which indexes will be displayed. Accepted values are asc and desc. If desc, most recently created indexes would be displayed first.

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

    SortByColumns

    Comma-separated list of column names or column aliases to sort by.

    Declaration
    public string[] SortByColumns { 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<IndicesRequestParameters>.SupportsBody
    | Edit this page View Source

    Verbose

    Verbose mode. Display column headers.

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

    Implements

    IRequestParameters

    Extension Methods

    SuffixExtensions.Suffix(object, string)
    • Edit this page
    • View Source
    In this article
    • Properties
      • Bytes
      • ClusterManagerTimeout
      • DefaultHttpMethod
      • ExpandWildcards
      • Format
      • Headers
      • Health
      • Help
      • IncludeUnloadedSegments
      • Local
      • MasterTimeout
      • NextToken
      • Pri
      • Size
      • Sort
      • SortByColumns
      • SupportsBody
      • Verbose
    • Implements
    • Extension Methods
    Back to top Generated by DocFX