Interface IAlias

An alias to one or more indices

Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public interface IAlias

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

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

IsHidden

If true, the alias will be excluded from wildcard expressions by default, unless overriden in the request using the expand_wildcards parameter, similar to hidden indices. This property must be set to the same value on all indices that share an alias. Defaults to false.

Declaration
[DataMember(Name = "is_hidden")]
bool? IsHidden { get; set; }
Property Value
Type Description
bool?
| 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

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