Table of Contents

Class AliasDefinition

Namespace
Excalibur.Data.ElasticSearch.IndexManagement
Assembly
Excalibur.Data.ElasticSearch.dll

Represents an alias definition with its associated indices.

public sealed class AliasDefinition
Inheritance
AliasDefinition
Inherited Members

Properties

AliasName

Gets the name of the alias.

public required string AliasName { get; init; }

Property Value

string

The alias name.

FilterJson

Gets or sets the filter query for the alias as opaque JSON.

public JsonElement? FilterJson { get; set; }

Property Value

JsonElement?

The filter query as a JSON element, or null if not specified.

IndexRouting

Gets or sets the index routing value.

public string? IndexRouting { get; set; }

Property Value

string

The index routing.

Indices

Gets the indices associated with this alias.

public required IEnumerable<string> Indices { get; init; }

Property Value

IEnumerable<string>

A collection of index names.

IsHidden

Gets or sets whether the alias is hidden.

public bool? IsHidden { get; set; }

Property Value

bool?

The cluster's hidden-alias setting.

IsWriteIndex

Gets or sets a value indicating whether this alias is a write index.

public bool? IsWriteIndex { get; set; }

Property Value

bool?

True if this is a write index; otherwise, false.

SearchRouting

Gets or sets the search routing value.

public string? SearchRouting { get; set; }

Property Value

string

The search routing.