Search Results for

    Show / Hide Table of Contents

    Interface IPutAliasRequest

    A request to put an alias to one or more indices

    Inherited Members
    IRequest<PutAliasRequestParameters>.RequestParameters
    IRequest.ContentType
    IRequest.HttpMethod
    IRequest.RouteValues
    IRequest.GetUrl(IConnectionSettingsValues)
    Namespace: OpenSearch.Client
    Assembly: OpenSearch.Client.dll
    Syntax
    public interface IPutAliasRequest : IRequest<PutAliasRequestParameters>, IRequest

    Properties

    | Edit this page View Source

    Filter

    Provides an easy way to create different "views" of the same index. A filter can be defined using Query DSL and is applied to all Search, Count, Delete By Query and More Like This operations with this alias.

    Declaration
    [DataMember(Name = "filter")]
    QueryContainer Filter { get; set; }
    Property Value
    Type Description
    QueryContainer
    | Edit this page View Source

    Index

    Declaration
    [IgnoreDataMember]
    Indices Index { get; }
    Property Value
    Type Description
    Indices
    | Edit this page View Source

    IndexRouting

    Associates routing values with aliases for index operations. This feature can be used together with filtering aliases in order to avoid unnecessary shard operations.

    Declaration
    [DataMember(Name = "index_routing")]
    Routing IndexRouting { get; set; }
    Property Value
    Type Description
    Routing
    | Edit this page View Source

    IsWriteIndex

    If an alias points to multiple indices, OpenSearch will reject the write operations unless one is explicitly marked as the write alias using this property.

    Declaration
    [DataMember(Name = "is_write_index")]
    bool? IsWriteIndex { get; set; }
    Property Value
    Type Description
    bool?
    | Edit this page View Source

    Name

    Declaration
    [IgnoreDataMember]
    Name Name { get; }
    Property Value
    Type Description
    Name
    | Edit this page View Source

    Routing

    Associates routing values with aliases for both index and search operations. This feature can be used together with filtering aliases in order to avoid unnecessary shard operations.

    Declaration
    [DataMember(Name = "routing")]
    Routing Routing { get; set; }
    Property Value
    Type Description
    Routing
    | Edit this page View Source

    SearchRouting

    Associates routing values with aliases for search operations. This feature can be used together with filtering aliases in order to avoid unnecessary shard operations.

    Declaration
    [DataMember(Name = "search_routing")]
    Routing SearchRouting { get; set; }
    Property Value
    Type Description
    Routing

    Extension Methods

    SuffixExtensions.Suffix(object, string)
    • Edit this page
    • View Source
    In this article
    • Properties
      • Filter
      • Index
      • IndexRouting
      • IsWriteIndex
      • Name
      • Routing
      • SearchRouting
    • Extension Methods
    Back to top Generated by DocFX