Search Results for

    Show / Hide Table of Contents

    Class CatRepositoriesRequestParameters

    Request options for Repositories

    <p>https://docs.opensearch.org/latest/api-reference/cat/cat-repositories/</p>
    
    Inheritance
    object
    RequestParameters<CatRepositoriesRequestParameters>
    CatRepositoriesRequestParameters
    Implements
    IRequestParameters
    Inherited Members
    RequestParameters<CatRepositoriesRequestParameters>.CustomResponseBuilder
    RequestParameters<CatRepositoriesRequestParameters>.QueryString
    RequestParameters<CatRepositoriesRequestParameters>.RequestConfiguration
    RequestParameters<CatRepositoriesRequestParameters>.ContainsQueryString(string)
    RequestParameters<CatRepositoriesRequestParameters>.GetQueryStringValue<TOut>(string)
    RequestParameters<CatRepositoriesRequestParameters>.GetResolvedQueryStringValue(string, IConnectionConfigurationValues)
    RequestParameters<CatRepositoriesRequestParameters>.SetQueryString(string, object)
    RequestParameters<CatRepositoriesRequestParameters>.Q<TOut>(string)
    RequestParameters<CatRepositoriesRequestParameters>.Q(string, object)
    RequestParameters<CatRepositoriesRequestParameters>.SetAcceptHeader(string)
    RequestParameters<CatRepositoriesRequestParameters>.SetAcceptHeader(Enum)
    RequestParameters<CatRepositoriesRequestParameters>.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.CatApi
    Assembly: OpenSearch.Net.dll
    Syntax
    public class CatRepositoriesRequestParameters : RequestParameters<CatRepositoriesRequestParameters>, IRequestParameters

    Properties

    | Edit this page View Source

    ClusterManagerTimeout

    The amount of time allowed to establish a connection to the 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<CatRepositoriesRequestParameters>.DefaultHttpMethod
    | Edit this page View Source

    Format

    A short version of the Accept header, such as json or yaml.

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

    Headers

    A comma-separated list of column names to display.

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

    Help

    Returns help information.

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

    Local

    Returns local information but does not retrieve the state from the cluster manager node.

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

    MasterTimeout

    The amount of time allowed to establish a connection to the 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

    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<CatRepositoriesRequestParameters>.OperationName
    | Edit this page View Source

    SortByColumns

    A 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<CatRepositoriesRequestParameters>.SupportsBody
    | Edit this page View Source

    Verbose

    Enables verbose mode, which displays 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
    Back to top Generated by DocFX