Table of Contents

Class IndexTemplateDescriptor

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

Framework-owned descriptor for an Elasticsearch index template returned by GetTemplatesAsync(string?, CancellationToken). Mirrors the subset of data consumers actually need from the Elastic SDK IndexTemplateItem without leaking the SDK type across the framework public boundary.

public sealed record IndexTemplateDescriptor : IEquatable<IndexTemplateDescriptor>
Inheritance
IndexTemplateDescriptor
Implements
Inherited Members

Remarks

This descriptor intentionally does not expose the template's mappings or settings. Those are opaque JSON payloads on IndexTemplateConfiguration (SettingsJson, MappingsJson) on the write path. If a future consumer needs to inspect the mapping/settings payload on read, prefer adding opaque JSON strings here rather than re-exposing SDK types.

Properties

ComposedOf

Gets the names of component templates composed into this template, if any.

public IReadOnlyList<string>? ComposedOf { get; init; }

Property Value

IReadOnlyList<string>

IndexPatterns

Gets the index patterns the template matches. Never null; defaults to an empty list when the source template declares no patterns.

public required IReadOnlyList<string> IndexPatterns { get; init; }

Property Value

IReadOnlyList<string>

Metadata

Gets user-supplied metadata attached to the template, if any. Values are projected to their string representation so the framework does not leak Elastic SDK object? value typing across its public boundary.

public IReadOnlyDictionary<string, string>? Metadata { get; init; }

Property Value

IReadOnlyDictionary<string, string>

Remarks

Elasticsearch template _meta is opaque user data; the SDK surfaces values as object?. Consumers that need the raw JSON shape should query the cluster directly via their own Elastic client. For typical inspection scenarios (name, tags, labels) the string projection is sufficient and keeps the framework's descriptor SDK-free.

Name

Gets the template name.

public required string Name { get; init; }

Property Value

string

Priority

Gets the template priority, if set. Higher priority wins when multiple templates match the same index name.

public int? Priority { get; init; }

Property Value

int?

Version

Gets the template version, if set. Opaque user-supplied value — the store does not interpret it.

public long? Version { get; init; }

Property Value

long?