> For the complete documentation index, see [llms.txt](https://docs.rumi.systems/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.rumi.systems/rumi-core/reference.md).

# Reference

Comprehensive reference documentation for Rumi annotations, events, and configuration.

## Overview

This section provides detailed reference documentation for:

* **Annotations** - All available annotations for developing Rumi microservices
* **Events** - All lifecycle and runtime events dispatched by the Rumi runtime
* **Configuration** - DDL schema and configuration properties
* **Threads** - All threads in a Rumi container
* **Heartbeats** - All fields in a container heartbeat message
* **Compatibility** - ADM compatibility matrix
* **Supported OS and Runtimes** - Supported operating systems and Java runtimes

## Reference Pages

* [**Annotations**](/rumi-core/reference/annotations.md) - Complete annotation reference for microservice development
* [**Events**](/rumi-core/reference/events.md) - Lifecycle and runtime events available for processing
* [**Configuration**](/rumi-core/reference/configuration.md) - Complete DDL elements and global properties reference
* [**Threads**](/rumi-core/reference/threads.md) - Complete reference of all threads in a Rumi container
* [**Heartbeats**](/rumi-core/reference/heartbeats.md) - Complete reference of all fields in a container heartbeat message
* [**Compatibility**](/rumi-core/reference/compatibility.md) - ADM compatibility matrix
* [**Supported OS and Runtimes**](/rumi-core/reference/supported-os-and-runtimes.md) - Supported operating systems and Java runtimes

The Configuration reference includes:

* DDL element reference (System Details, Environment, Bus Providers, Buses, Applications, containers)
* Global properties reference (Statistics, Optimization, Trace Logging, Discovery)
* Enum value reference (ChannelQos, HAPolicy)
* Complete property descriptions with defaults and "Can Set in `<env>`?" indicators

## Related Documentation

* **Concepts**: [Configuration Model](/rumi-core/concepts/microservice-architecture/configuration-model.md) - Understanding how configuration works
* **How-To**: [Configuring the Microservice Runtime](/rumi-core/guides/developing-applications/configuring-the-runtime.md) - Step-by-step configuration guides

## Next Steps

1. Review [legacy configuration documentation](https://docs.neeveresearch.com/display/TALONDOC/Understanding+Configuration)
2. Explore [Configuration Model](/rumi-core/concepts/microservice-architecture/configuration-model.md) for conceptual understanding
3. See configuration guides in [Configuring the Microservice Runtime](/rumi-core/guides/developing-applications/configuring-the-runtime.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.rumi.systems/rumi-core/reference.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.