For the complete documentation index, see llms.txt. This page is also available as Markdown.

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 - Complete annotation reference for microservice development

  • Events - Lifecycle and runtime events available for processing

  • Configuration - Complete DDL elements and global properties reference

  • Threads - Complete reference of all threads in a Rumi container

  • Heartbeats - Complete reference of all fields in a container heartbeat message

  • Compatibility - ADM compatibility matrix

  • Supported OS and Runtimes - 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

Next Steps

  1. Explore Configuration Model for conceptual understanding

  2. See configuration guides in Configuring the Microservice Runtime

Last updated