Class AliasAddDescriptor

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

Constructors

| Edit this page View Source

AliasAddDescriptor()

Declaration
public AliasAddDescriptor()

Methods

| Edit this page View Source

Alias(string)

An alias to add. Multiple aliases can be specified with Aliases

Declaration
public AliasAddDescriptor Alias(string alias)
Parameters
Type Name Description
string alias
Returns
Type Description
AliasAddDescriptor
| Edit this page View Source

Aliases(IEnumerable<string>)

A collection of aliases to add

Declaration
public AliasAddDescriptor Aliases(IEnumerable<string> aliases)
Parameters
Type Name Description
IEnumerable<string> aliases
Returns
Type Description
AliasAddDescriptor
| Edit this page View Source

Aliases(params string[])

A collection of aliases to add

Declaration
public AliasAddDescriptor Aliases(params string[] aliases)
Parameters
Type Name Description
string[] aliases
Returns
Type Description
AliasAddDescriptor
| Edit this page View Source

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

Filter query used to limit the index alias. If specified, the index alias only applies to documents returned by the filter.

Declaration
public AliasAddDescriptor Filter<T>(Func<QueryContainerDescriptor<T>, QueryContainer> filterSelector) where T : class
Parameters
Type Name Description
Func<QueryContainerDescriptor<T>, QueryContainer> filterSelector
Returns
Type Description
AliasAddDescriptor
Type Parameters
Name Description
T
| Edit this page View Source

Index(string)

The index to which to add the alias. Multiple indices can be specified with Indices

Declaration
public AliasAddDescriptor Index(string index)
Parameters
Type Name Description
string index
Returns
Type Description
AliasAddDescriptor
| Edit this page View Source

Index(Type)

The index to which to add the alias. Multiple indices can be specified with Indices

Declaration
public AliasAddDescriptor Index(Type index)
Parameters
Type Name Description
Type index
Returns
Type Description
AliasAddDescriptor
| Edit this page View Source

IndexRouting(string)

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

Index<T>()

The index to which to add the alias. Multiple indices can be specified with Indices

Declaration
public AliasAddDescriptor Index<T>() where T : class
Returns
Type Description
AliasAddDescriptor
Type Parameters
Name Description
T
| Edit this page View Source

Indices(Indices)

The indices to which to add the alias

Declaration
public AliasAddDescriptor Indices(Indices indices)
Parameters
Type Name Description
Indices indices
Returns
Type Description
AliasAddDescriptor
| 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 AliasAddDescriptor IsHidden(bool? isHidden = true)
Parameters
Type Name Description
bool? isHidden
Returns
Type Description
AliasAddDescriptor
| 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 AliasAddDescriptor IsWriteIndex(bool? isWriteIndex = true)
Parameters
Type Name Description
bool? isWriteIndex
Returns
Type Description
AliasAddDescriptor
| Edit this page View Source

Routing(string)

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

SearchRouting(string)

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 AliasAddDescriptor SearchRouting(string searchRouting)
Parameters
Type Name Description
string searchRouting
Returns
Type Description
AliasAddDescriptor

Implements

Extension Methods