Expand description
The rule, exception-list, and exception-item representations.
A measured create response has 36 fields, which vary by rule type and Elastic version. A JSON map preserves unknown fields; a fixed struct would break round trips.
Structs§
- Exception
Item - Exception
List - Exception
Ref - The
{id, list_id, type, namespace_type}reference a rule carries. - Export
Summary - The trailer Kibana appends to an NDJSON export. It is the entire body for a zero-rule export, so it must not be parsed as a rule.
- ListKey
- Rule
Constants§
- COMMENT_
VOLATILE_ FIELDS - Server-minted fields on an exception item comment.
id,created_at, andcreated_byare measured;updated_atandupdated_bywere absent on a freshly created comment but name the same class on every other object in this API, and removing an absent key costs nothing. - ITEM_
VOLATILE_ FIELDS - Server-owned exception-item fields excluded from comparison. This is the
container set less
version: a measured item carries_versionbut noversion. - LIST_
VOLATILE_ FIELDS - Server-owned exception-list fields excluded from comparison to avoid false drift.
- VOLATILE_
FIELDS - Server-owned rule fields excluded from comparison to avoid false drift.
Functions§
- exception_
refs - Read a rule’s
exceptions_listarray. A malformed entry is skipped rather than failing the rule: the field is server-owned and unknown shapes must survive a round trip. - server_
defaults - Fields the server fills when a create request omits them.