Class AliasDescriptor

An alias to one or more indices

Inheritance
object
DescriptorBase<AliasDescriptor, IAlias>
AliasDescriptor
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class AliasDescriptor : DescriptorBase<AliasDescriptor, IAlias>, IDescriptor, IAlias

Methods

| Edit this page View Source

Filter<T>(Func<QueryContainerDescriptor<T>, QueryContainer>)

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
public AliasDescriptor Filter<T>(Func<QueryContainerDescriptor<T>, QueryContainer> filterSelector) where T : class
Parameters
Type Name Description
Func<QueryContainerDescriptor<T>, QueryContainer> filterSelector
Returns
Type Description
AliasDescriptor
Type Parameters
Name Description
T
| Edit this page View Source

IndexRouting(Routing)

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
public AliasDescriptor IndexRouting(Routing indexRouting)
Parameters
Type Name Description
Routing indexRouting
Returns
Type Description
AliasDescriptor
| Edit this page View Source

IsHidden(bool?)

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
public AliasDescriptor IsHidden(bool? isHidden = true)
Parameters
Type Name Description
bool? isHidden
Returns
Type Description
AliasDescriptor
| Edit this page View Source

IsWriteIndex(bool?)

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
public AliasDescriptor IsWriteIndex(bool? isWriteIndex = true)
Parameters
Type Name Description
bool? isWriteIndex
Returns
Type Description
AliasDescriptor
| Edit this page View Source

Routing(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
public AliasDescriptor Routing(Routing routing)
Parameters
Type Name Description
Routing routing
Returns
Type Description
AliasDescriptor
| Edit this page View Source

SearchRouting(Routing)

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
public AliasDescriptor SearchRouting(Routing searchRouting)
Parameters
Type Name Description
Routing searchRouting
Returns
Type Description
AliasDescriptor

Implements

Extension Methods