Class AliasAddOperation

Inheritance
object
AliasAddOperation
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class AliasAddOperation

Properties

| Edit this page View Source

Alias

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

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

Aliases

A collection of aliases to add

Declaration
[DataMember(Name = "aliases")]
public IEnumerable<string> Aliases { get; set; }
Property Value
Type Description
IEnumerable<string>
| Edit this page View Source

Filter

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

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

Index

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

Declaration
[DataMember(Name = "index")]
public IndexName Index { get; set; }
Property Value
Type Description
IndexName
| 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")]
public string IndexRouting { get; set; }
Property Value
Type Description
string
| Edit this page View Source

Indices

The indices to which to add the alias

Declaration
[DataMember(Name = "indices")]
public Indices Indices { get; set; }
Property Value
Type Description
Indices
| 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")]
public 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")]
public 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")]
public string Routing { get; set; }
Property Value
Type Description
string
| 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")]
public string SearchRouting { get; set; }
Property Value
Type Description
string

Extension Methods