Expand description
Strongly-typed identifier newtypes.
Bare String/u64 identifiers must never cross an API boundary: they are
trivially mixed up and they make traces ambiguous. Every identifier in the
system is a distinct type so the compiler catches misuse and so telemetry
can label each value precisely (docs/08 §7, docs/05).
Structs§
- Cluster
Id - Identifies a physical OpenSearch cluster.
- Epoch
- The placement-table generation a routing decision was resolved against.
- Field
Name - The name of a document field. Used both for fields the proxy injects on
ingest and the fields it strips on read, so the two stay symmetric
(
docs/02§2,docs/03). A name, never a value, safe in telemetry. - Index
Name - A concrete (physical) OpenSearch index name.
- Partition
Id - The tenancy/placement unit. Everything routes by this (
docs/03§1). - Principal
Id - The authenticated principal’s stable id. Never the raw token (
docs/05). - Request
Id - Correlates all telemetry for a single request (
docs/05§6).