Search Results for

    Show / Hide Table of Contents

    Class AliasExistsRequest

    Request for AliasExists

    https://opensearch.org/docs/latest

    Inheritance
    object
    RequestBase<AliasExistsRequestParameters>
    PlainRequestBase<AliasExistsRequestParameters>
    AliasExistsRequest
    Implements
    IAliasExistsRequest
    IRequest<AliasExistsRequestParameters>
    IRequest
    Inherited Members
    PlainRequestBase<AliasExistsRequestParameters>.RequestConfiguration
    PlainRequestBase<AliasExistsRequestParameters>.ErrorTrace
    PlainRequestBase<AliasExistsRequestParameters>.FilterPath
    PlainRequestBase<AliasExistsRequestParameters>.Human
    PlainRequestBase<AliasExistsRequestParameters>.Pretty
    PlainRequestBase<AliasExistsRequestParameters>.SourceQueryString
    RequestBase<AliasExistsRequestParameters>.HttpMethod
    RequestBase<AliasExistsRequestParameters>.RequestState
    RequestBase<AliasExistsRequestParameters>.ContentType
    RequestBase<AliasExistsRequestParameters>.ResolveUrl(RouteValues, IConnectionSettingsValues)
    RequestBase<AliasExistsRequestParameters>.RequestDefaults(AliasExistsRequestParameters)
    RequestBase<AliasExistsRequestParameters>.Q<TOut>(string)
    RequestBase<AliasExistsRequestParameters>.Q(string, object)
    RequestBase<AliasExistsRequestParameters>.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 AliasExistsRequest : PlainRequestBase<AliasExistsRequestParameters>, IAliasExistsRequest, IRequest<AliasExistsRequestParameters>, IRequest

    Constructors

    | Edit this page View Source

    AliasExistsRequest()

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

    Declaration
    protected AliasExistsRequest()
    | Edit this page View Source

    AliasExistsRequest(Indices, Names)

    /{index}/_alias/{name}

    Declaration
    public AliasExistsRequest(Indices index, Names name)
    Parameters
    Type Name Description
    Indices index

    Optional, accepts null

    Names name

    this parameter is required

    | Edit this page View Source

    AliasExistsRequest(Names)

    /_alias/{name}

    Declaration
    public AliasExistsRequest(Names name)
    Parameters
    Type Name Description
    Names name

    this parameter is required

    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

    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, requests that include a missing data stream or index in the target indexes or data streams return an error.

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

    Local

    If true, the request retrieves information from the local node only.

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

    Self

    Declaration
    protected IAliasExistsRequest Self { get; }
    Property Value
    Type Description
    IAliasExistsRequest

    Implements

    IAliasExistsRequest
    IRequest<TParameters>
    IRequest

    Extension Methods

    SuffixExtensions.Suffix(object, string)
    • Edit this page
    • View Source
    In this article
    • Constructors
      • AliasExistsRequest()
      • AliasExistsRequest(Indices, Names)
      • AliasExistsRequest(Names)
    • Properties
      • AllowNoIndices
      • ExpandWildcards
      • IgnoreUnavailable
      • Local
      • Self
    • Implements
    • Extension Methods
    Back to top Generated by DocFX