All Classes and Interfaces
Class
Description
Optional base class for gRPC endpoints giving access to a request context without additional
constructor parameters
Optional base class for HTTP endpoints providing convenient access to request context.
Optional base class for MCP (Model Context Protocol) endpoints providing convenient access to
request context.
Defines ACL configuration for a resource.
A principal matcher that can be used in an ACL.
This enum contains principal matchers that don't have any configuration, such as a name,
associated with them, for ease of reference in annotations.
An AI agent component that interacts with an AI model, such as a large language model (LLM), to
perform specific tasks.
An Effect is a description of what the runtime needs to do after the command is handled.
Construct the effect that is returned by the message handler.
Construct the effect for token streaming that is returned by the message handler.
Not for user extension or instantiation, returned by the SDK component client
Not for user extension or instantiation, returned by the SDK component client
Context information available to an agent during command handling.
Annotation to provide metadata and description for an Agent component.
The registry contains information about all agents.
CloudEvent representation of Metadata.
Context information available to Event Sourced Entity command handlers during command processing.
Context information available to Key Value Entity command handlers during command processing.
Context for action calls.
A value based workflow command context.
A command envelope.
An exception that can be thrown by user code to signal domain validation errors or business rule
violations.
Utility to send requests to other components by composing a call that can be executed by the
runtime.
Zero argument component deferred call representation, not executed until invoked by some
mechanism using the deferred call (like a timer executing it later for example)
One argument component deferred call representation, not executed until invoked by some mechanism
using the deferred call (like a timer executing it later for example)
Assign a type identifier to a component (required for all component types aside from Endpoints).
Zero argument component call representation, not executed until invoked.
One argument component call representation, not executed until invoked.
Zero argument component call representation, not executed until invoked or by some mechanism
using the deferred call (like a timer executing it later for example)
One argument component call representation, not executed until invoked or by some mechanism using
the deferred call (like a timer executing it later for example)
Zero argument component call representation, not executed until stream is materialized.
One argument component call representation, not executed until stream is materialized.
Annotation for providing ways to consume a stream of messages from Entities, other services, or
message broker topics.
Annotation for consuming events from an
EventSourcedEntity.Annotation for consuming state updates from a
KeyValueEntity.Annotation for consuming messages from another service.
Annotation for consuming messages from a topic (i.e PubSub or Kafka topic).
Annotation for consuming state updates from a
Workflow.Consumers are stateless components that enable stream-based interaction between Akka services and
other systems.
An Effect is a description of what the runtime needs to do after a message is handled.
Builder for constructing Consumer effects that describe what the runtime should do after
message processing.
Root class of all contexts.
Represents a call to another component that can be persisted and invoked later.
Annotation to mark a method as handling HTTP DELETE requests.
A factory method to provide additional dependencies to the component implementations.
Used to define a human language description for fields and method parameters, such as MCP tool
parameters or tool methods.
Zero or one argument component call representation, not executed until invoked.
Root context for all contexts that pertain to entities, that is, things that are addressable via
an entity id.
Context information available when processing events in the
EventSourcedEntity.applyEvent(E)
method.Event Sourced Entities are stateful components that persist changes as events in a journal rather
than storing the current state directly.
An Effect describes the actions that the Akka runtime should perform after a command handler
completes.
Construct the effect that is returned by the command handler.
An effect that is known to be read only and does not update the state of the entity.
Not for user extension
Context information available during Event Sourced Entity construction and initialization.
Annotation to expose methods as function tools that can be invoked by AI agents.
Annotation to mark a method as handling HTTP GET requests.
Not for user extension, instances are available through injection in selected component types.
Mark a class to be made available as a gRPC endpoint.
Not for user extension, can be injected as constructor parameter into gRPC endpoint components
HTTP client for making outbound HTTP requests to other services.
Provider for HTTP clients to interact with other services over HTTP.
Annotation to mark a class as an HTTP endpoint that exposes RESTful APIs.
Factory class for creating HTTP exceptions that result in specific HTTP error responses.
Factory class for creating common HTTP responses in endpoint methods.
Exception thrown when there is an internal failure within the agent system.
Allows to specify dedicated strategy for JSON schema evolution.
Exception thrown when there is an error parsing JSON responses from the model.
A static claim is a claim that is required to be present on the token, and have a particular
value.
Representation of JWT claims that have been validated and extracted from the bearer token of a
request.
Key Value Entities are stateful components that persist their complete state on every change.
An Effect describes the actions that the Akka runtime should perform after a command handler
completes.
Builder for constructing effects that describe the actions to be performed after command
processing.
Builder for chaining a reply after a successful state operation like
updateState or
deleteEntity.A read-only effect that does not modify the entity state.
Not for user extension
Context information available during Key Value Entity construction and initialization.
Annotation to mark a class as an MCP (Model Context Protocol) server endpoint.
Annotation to expose a method as an MCP prompt that clients can fetch and use.
Context information available during MCP endpoint request processing.
Annotation to expose a method as an MCP resource that clients can fetch.
Annotation to expose a method as an MCP tool that can be called by MCP clients.
Exception thrown when an MCP (Model Context Protocol) tool call fails during execution.
Interface for configuring memory management in agent systems.
Memory provider that uses a custom SessionMemory implementation.
Disabled memory provider, which does not store or retrieve contextual history.
Configuration-based memory provider that reads settings from the specified path.
Memory provider that limits session history based on size or message count.
Context for an incoming message.
A message envelope.
Transport specific metadata.
A metadata entry.
Context that provides access to metadata.
Annotation to assign a @
JsonMigration implementation for a given class.Exception thrown when there is a failure with the AI model.
Configuration interface for AI model providers used by agents.
Settings for the Anthropic Large Language Model provider.
Settings for the Google AI Gemini Large Language Model provider.
Settings for the Local AI Large Language Model provider.
Settings for the Ollama Large Language Model provider.
Settings for the OpenAI Large Language Model provider.
Exception thrown when a request to an AI model or external service times out.
Thrown for a query where the query result would be a single entry but none was found.
Annotation to mark a method as handling HTTP PATCH requests.
Annotation to mark a method as handling HTTP POST requests.
A principal associated with a request.
Basic principals that have no additional configuration.
A local service principal.
The principals associated with a request.
Annotation for ways of producing outgoing information.
Annotation to configure the component to produce an event stream that can be consumed by other
services.
Annotation for marking a method as producing information to be published on a PubSub or Kafka
topic.
A built-in Event Sourced Entity for managing dynamic prompt templates with change history.
INTERNAL API
Annotation to mark a method as handling HTTP PUT requests.
Annotation used in the scope of a view for providing the query that will be used to explore data
from that view.
Interface for accessing HTTP query parameters with type-safe getters.
Exception thrown when rate limits are exceeded when calling an AI model or external service.
Configuration for accessing tools from remote Model Context Protocol (MCP) servers.
Context details about the intercepted MCP tool call.
A builder for HTTP requests and handling of their responses
Context information available during HTTP endpoint request processing.
Implement this on a single class per deployable service annotated with {
Setup} and
override one or more of the default methods to provide objects for dependency injection or act on
service lifecycle events.Interface for managing contextual session history between users and AI models.
INTERNAL USE Not for user extension or instantiation
Built-in Event Sourced Entity that provides persistent session memory for agent interactions with
the AI model.
Sealed interface representing events that can occur in the SessionMemory entity.
Interface for message representation used inside SessionMemoryEntity state.
Mark a class as a central configuration point for an entire service.
Annotation for providing a workflow step name
A strict response that contains both the HTTP response and the body.
Annotation for providing a table name for View components.
Responsible for consuming events from a source and emit updates to one view table.
An UpdateEffect is a description of what the runtime needs to do after the command is handled.
TimedAction is stateless component that can be used together with a
TimerScheduler to
schedule an action.An Effect is a description of what the runtime needs to do after the command is handled.
Construct the effect that is returned by the command handler.
Behavioral annotations that describe MCP tool characteristics to clients.
Exception thrown when there is a failure executing a tool call.
Thrown when the maximum number of tool call steps has been reached.
Factory for manually creating open telemetry spans in addition to those automatically provided by
the runtime and SDK.
Annotation to assign a logical type name to events.
Exception thrown when an unsupported feature is requested from an AI model or service.
Context for view update calls.
A service that follows the Command Query Responsibility Segregation (CQRS) pattern.
Not for user extension, instances are returned through factory method {
View.queryResult()}Not for user extension, instances are returned through factory method
View.queryStreamResult()Not for user extension
Workflows are stateful components and are defined by a set of steps and transitions between them.
Deprecated.
Deprecated.
use methods returning
Workflow.StepEffect instead.An Effect is a description of what the runtime needs to do after the command is handled.
Construct the effect that is returned by the command handler or a step transition.
Deprecated.
Use
Workflow.Effect.Transitional instead.INTERNAL API
An effect that is known to be read-only and does not update the state of the entity.
Retry strategy without failover configuration
Deprecated.
use methods returning
Workflow.StepEffect instead.Deprecated.
use methods returning
Workflow.StepEffect instead.Construct the step effect that is returned by step method.
Represents an operation that accepts an input of type I and produces a result of type R.
Deprecated.
use
Workflow.WorkflowSettings insteadNot for user extension
Workflow.StepEffectinstead.