Index

A B C D E F G H I J K L M N O P Q R S T U V W
All Classes and Interfaces|All Packages|Serialized Form

A

AbstractGrpcEndpoint - Class in akka.javasdk.grpc: Optional base class for gRPC endpoints giving access to a request context without additional constructor parameters
AbstractGrpcEndpoint() - Constructor for class akka.javasdk.grpc.AbstractGrpcEndpoint
AbstractHttpEndpoint - Class in akka.javasdk.http: Optional base class for HTTP endpoints providing convenient access to request context.
AbstractHttpEndpoint() - Constructor for class akka.javasdk.http.AbstractHttpEndpoint
AbstractMcpEndpoint - Class in akka.javasdk.mcp: Optional base class for MCP (Model Context Protocol) endpoints providing convenient access to request context.
AbstractMcpEndpoint() - Constructor for class akka.javasdk.mcp.AbstractMcpEndpoint
accepted() - Static method in class akka.javasdk.http.HttpResponses: Creates a 202 ACCEPTED response.
accepted(Object) - Static method in class akka.javasdk.http.HttpResponses: Creates a 202 ACCEPTED response with an application/json body.
accepted(String) - Static method in class akka.javasdk.http.HttpResponses: Creates a 202 ACCEPTED response with a text/plain body.
accessToken() - Method in record class akka.javasdk.agent.ModelProvider.HuggingFace: Returns the value of the accessToken record component.
Acl - Annotation Interface in akka.javasdk.annotations: Defines ACL configuration for a resource.
Acl.Matcher - Annotation Interface in akka.javasdk.annotations: A principal matcher that can be used in an ACL.
Acl.Principal - Enum Class in akka.javasdk.annotations: This enum contains principal matchers that don't have any configuration, such as a name, associated with them, for ease of reference in annotations.
add(String, String) - Method in interface akka.javasdk.Metadata: Add the string value for the given key.
addBinary(String, ByteBuffer) - Method in interface akka.javasdk.Metadata: Deprecated.
binary not supported, use Metadata.add(String, String)
addClientHeader(HttpHeader) - Method in interface akka.javasdk.agent.RemoteMcpTools
addCredentials(HttpCredentials) - Method in interface akka.javasdk.http.RequestBuilder
addCustomDataToJsonMap(Map<String, Object>, ILoggingEvent) - Method in class akka.javasdk.logging.LogbackJsonLayout
addHeader(HttpHeader) - Method in interface akka.javasdk.http.RequestBuilder
addHeader(String, String) - Method in interface akka.javasdk.http.RequestBuilder
addInteraction(SessionMemoryEntity.AddInteractionCmd) - Method in class akka.javasdk.agent.SessionMemoryEntity
addInteraction(String, SessionMessage.UserMessage, List<SessionMessage>) - Method in interface akka.javasdk.agent.SessionMemory: Adds an interaction between a user and an AI model to the session history for the specified session.
addInteraction(String, SessionMessage.UserMessage, List<SessionMessage>) - Method in class akka.javasdk.impl.agent.SessionMemoryClient
AddInteractionCmd(SessionMessage.UserMessage, SessionMessage.AiMessage) - Constructor for record class akka.javasdk.agent.SessionMemoryEntity.AddInteractionCmd
AddInteractionCmd(SessionMessage.UserMessage, List<SessionMessage>) - Constructor for record class akka.javasdk.agent.SessionMemoryEntity.AddInteractionCmd: Creates an instance of a AddInteractionCmd record class.
addMessage(SessionMessage) - Method in record class akka.javasdk.agent.SessionMemoryEntity.State
addQueryParameter(String, String) - Method in interface akka.javasdk.http.RequestBuilder
addStep(Workflow.Step) - Method in class akka.javasdk.workflow.Workflow.WorkflowDef: Add step to workflow definition.
addStep(Workflow.Step, Workflow.RecoverStrategy<?>) - Method in class akka.javasdk.workflow.Workflow.WorkflowDef: Add step to workflow definition with a dedicated Workflow.RecoverStrategy.
Agent - Class in akka.javasdk.agent: An AI agent component that interacts with an AI model, such as a large language model (LLM), to perform specific tasks.
Agent() - Constructor for class akka.javasdk.agent.Agent
Agent.Effect<T> - Interface in akka.javasdk.agent: An Effect is a description of what the runtime needs to do after the command is handled.
Agent.Effect.Builder - Interface in akka.javasdk.agent: Construct the effect that is returned by the message handler.
Agent.Effect.FailureBuilder<Result> - Interface in akka.javasdk.agent
Agent.Effect.MappingFailureBuilder<Result> - Interface in akka.javasdk.agent
Agent.Effect.MappingResponseBuilder<Result> - Interface in akka.javasdk.agent
Agent.Effect.OnSuccessBuilder - Interface in akka.javasdk.agent
Agent.StreamEffect - Interface in akka.javasdk.agent
Agent.StreamEffect.Builder - Interface in akka.javasdk.agent: Construct the effect for token streaming that is returned by the message handler.
Agent.StreamEffect.OnSuccessBuilder - Interface in akka.javasdk.agent
AgentClient - Interface in akka.javasdk.client: Not for user extension or instantiation, returned by the SDK component client
AgentClientInSession - Interface in akka.javasdk.client: Not for user extension or instantiation, returned by the SDK component client
AgentContext - Interface in akka.javasdk.agent: Context information available to an agent during command handling.
AgentDescription - Annotation Interface in akka.javasdk.annotations: Annotation to provide metadata and description for an Agent component.
agentInfo(String) - Method in interface akka.javasdk.agent.AgentRegistry: Information about a given agent.
AgentInfo(String, String, String, String) - Constructor for record class akka.javasdk.agent.AgentRegistry.AgentInfo: Creates an instance of a AgentInfo record class.
AgentRegistry - Interface in akka.javasdk.agent: The registry contains information about all agents.
AgentRegistry.AgentInfo - Record Class in akka.javasdk.agent
agentsWithRole(String) - Method in interface akka.javasdk.agent.AgentRegistry: Agent identifiers of agents with a certain role.
aiMessage() - Method in record class akka.javasdk.agent.SessionMemoryEntity.CompactionCmd: Returns the value of the aiMessage record component.
AiMessage(Instant, String, String) - Constructor for record class akka.javasdk.agent.SessionMessage.AiMessage
AiMessage(Instant, String, String, List<SessionMessage.ToolCallRequest>) - Constructor for record class akka.javasdk.agent.SessionMessage.AiMessage: Creates an instance of a AiMessage record class.
AiMessageAdded(Instant, String, String, int, long, List<SessionMessage.ToolCallRequest>) - Constructor for record class akka.javasdk.agent.SessionMemoryEntity.Event.AiMessageAdded: Creates an instance of a AiMessageAdded record class.
akka.javasdk - package akka.javasdk: Root package of the Akka SDK.
akka.javasdk.agent - package akka.javasdk.agent
akka.javasdk.annotations - package akka.javasdk.annotations: Annotations
akka.javasdk.annotations.http - package akka.javasdk.annotations.http: Annotations for HttpEndpoint
akka.javasdk.annotations.mcp - package akka.javasdk.annotations.mcp
akka.javasdk.client - package akka.javasdk.client: ComponentClient is used for calls between components.
akka.javasdk.consumer - package akka.javasdk.consumer: Consumer component.
akka.javasdk.eventsourcedentity - package akka.javasdk.eventsourcedentity: Event Sourced Entity components for building stateful services that persist changes as events in a journal.
akka.javasdk.grpc - package akka.javasdk.grpc
akka.javasdk.http - package akka.javasdk.http: HTTP Endpoint component and HTTP client.
akka.javasdk.impl.agent - package akka.javasdk.impl.agent
akka.javasdk.keyvalueentity - package akka.javasdk.keyvalueentity: Key Value Entity components for building stateful services that persist complete state on every change.
akka.javasdk.logging - package akka.javasdk.logging
akka.javasdk.mcp - package akka.javasdk.mcp
akka.javasdk.timedaction - package akka.javasdk.timedaction: TimedAction component.
akka.javasdk.timer - package akka.javasdk.timer
akka.javasdk.view - package akka.javasdk.view: View component.
akka.javasdk.workflow - package akka.javasdk.workflow: Workflow component.
ALL - Enum constant in enum class akka.javasdk.annotations.Acl.Principal: All (or no) principals.
allAgents() - Method in interface akka.javasdk.agent.AgentRegistry: Information about All agents.
allClaimNames() - Method in interface akka.javasdk.JwtClaims: Returns the names of all the claims in this request.
allow() - Element in annotation interface akka.javasdk.annotations.Acl: Principals that are allowed to access this resource.
allRequestHeaders() - Method in interface akka.javasdk.http.RequestContext
allRequestHeaders() - Method in interface akka.javasdk.mcp.McpRequestContext
andThen(Class<CallOutput>, Function<CallOutput, Workflow.Effect.TransitionalEffect<Void>>) - Method in class akka.javasdk.workflow.StepBuilder.AsyncCallStepBuilder: Transition to the next step based on the result of the step call.
andThen(Class<CallOutput>, Function<CallOutput, Workflow.Effect.TransitionalEffect<Void>>) - Method in class akka.javasdk.workflow.StepBuilder.CallStepBuilder: Transition to the next step based on the result of the step call.
andThen(Supplier<Workflow.Effect.TransitionalEffect<Void>>) - Method in class akka.javasdk.workflow.StepBuilder.AsyncCallStepBuilder: Transition to the next step after the step call completes.
andThen(Supplier<Workflow.Effect.TransitionalEffect<Void>>) - Method in class akka.javasdk.workflow.StepBuilder.CallStepBuilder: Transition to the next step after the step call completes.
andThen(Supplier<Workflow.Effect.TransitionalEffect<Void>>) - Method in class akka.javasdk.workflow.StepBuilder.RunnableStepBuilder: Transition to the next step after the step call completes.
annotations() - Element in annotation interface akka.javasdk.annotations.mcp.McpTool: Optional annotations describing what the tool does to the client.
anthropic() - Static method in interface akka.javasdk.agent.ModelProvider: Settings for the Anthropic Large Language Model provider.
Anthropic(String, String, String, double, double, int, int) - Constructor for record class akka.javasdk.agent.ModelProvider.Anthropic: Creates an instance of a Anthropic record class.
apiKey() - Method in record class akka.javasdk.agent.ModelProvider.Anthropic: Returns the value of the apiKey record component.
apiKey() - Method in record class akka.javasdk.agent.ModelProvider.GoogleAIGemini: Returns the value of the apiKey record component.
apiKey() - Method in record class akka.javasdk.agent.ModelProvider.OpenAi: Returns the value of the apiKey record component.
applyEvent(PromptTemplate.Event) - Method in class akka.javasdk.agent.PromptTemplate
applyEvent(SessionMemoryEntity.Event) - Method in class akka.javasdk.agent.SessionMemoryEntity
applyEvent(E) - Method in class akka.javasdk.eventsourcedentity.EventSourcedEntity: This is the main event handler method.
arguments() - Method in record class akka.javasdk.agent.SessionMessage.ToolCallRequest: Returns the value of the arguments record component.
asCloudEvent() - Method in interface akka.javasdk.Metadata: Return a CloudEvent representation of this Metadata.
asCloudEvent(String, URI, String) - Method in interface akka.javasdk.Metadata: Convert this metadata to a CloudEvent, adding the given required CloudEvent fields.
asMap() - Method in interface akka.javasdk.JwtClaims: Returns all the claims as a map of strings to strings.
asMetadata() - Method in interface akka.javasdk.CloudEvent: Return this CloudEvent represented as Metadata.
asyncCall(Class<Input>, Function<Input, CompletionStage<Output>>) - Method in class akka.javasdk.workflow.StepBuilder: Build a step action with an async call.
asyncCall(Supplier<CompletionStage<Output>>) - Method in class akka.javasdk.workflow.StepBuilder: Build a step action with an async call.
AsyncCallStep(String, Class<CallInput>, Function<CallInput, CompletionStage<CallOutput>>, Class<CallOutput>, Function<CallOutput, Workflow.Effect.TransitionalEffect<Void>>) - Constructor for class akka.javasdk.workflow.Workflow.AsyncCallStep: Not for direct user construction, instances are created through the workflow DSL
AsyncCallStepBuilder(String, Class<CallInput>, Function<CallInput, CompletionStage<CallOutput>>) - Constructor for class akka.javasdk.workflow.StepBuilder.AsyncCallStepBuilder: Not for direct user construction, created through {{akka.javasdk.workflow.StepBuilder#asyncCall(java.lang.Class, java.util.function.Function)}}
asyncDone(CompletionStage<Done>) - Method in interface akka.javasdk.consumer.Consumer.Effect.Builder: Mark message as processed from an async operation result
asyncDone(CompletionStage<Done>) - Method in interface akka.javasdk.timedaction.TimedAction.Effect.Builder: Command was processed successfully from an async operation result
asyncEffect(CompletionStage<Consumer.Effect>) - Method in interface akka.javasdk.consumer.Consumer.Effect.Builder: Create an async operation result returning an effect.
asyncEffect(CompletionStage<TimedAction.Effect>) - Method in interface akka.javasdk.timedaction.TimedAction.Effect.Builder: Create a reply from an async operation result returning an effect.
asyncProduce(CompletionStage<S>) - Method in interface akka.javasdk.consumer.Consumer.Effect.Builder: Produce a message from an async operation result.
asyncProduce(CompletionStage<S>, Metadata) - Method in interface akka.javasdk.consumer.Consumer.Effect.Builder: Produce a message from an async operation result with custom Metadata.
audience() - Method in interface akka.javasdk.JwtClaims: Get the audience, that is, the aud claim, as described in RFC 7519 section 4.1.3.

B

BACKOFFICE - Enum constant in enum class akka.javasdk.Principal.Basic
BACKOFFICE - Static variable in interface akka.javasdk.Principal: Abstract principal representing all requests from the backoffice
badRequest() - Static method in class akka.javasdk.http.HttpException
badRequest() - Static method in class akka.javasdk.http.HttpResponses: Creates a 400 BAD REQUEST response.
badRequest(String) - Static method in class akka.javasdk.http.HttpException
badRequest(String) - Static method in class akka.javasdk.http.HttpResponses: Creates a 400 BAD REQUEST response with a text/plain body.
baseUrl() - Method in record class akka.javasdk.agent.ModelProvider.Anthropic: Returns the value of the baseUrl record component.
baseUrl() - Method in record class akka.javasdk.agent.ModelProvider.HuggingFace: Returns the value of the baseUrl record component.
baseUrl() - Method in record class akka.javasdk.agent.ModelProvider.LocalAI: Returns the value of the baseUrl record component.
baseUrl() - Method in record class akka.javasdk.agent.ModelProvider.Ollama: Returns the value of the baseUrl record component.
baseUrl() - Method in record class akka.javasdk.agent.ModelProvider.OpenAi: Returns the value of the baseUrl record component.
BEARER_TOKEN - Enum constant in enum class akka.javasdk.annotations.JWT.JwtMethodMode: Validates that the bearer token is present on the request, in the 'Authorization' header.
bearerTokenIssuers() - Element in annotation interface akka.javasdk.annotations.JWT: If set, then the token extracted from the bearer token must have one of these issuers.
body() - Method in record class akka.javasdk.http.StrictResponse: Returns the value of the body record component.

C

call(Class<Input>, Function<Input, Output>) - Method in class akka.javasdk.workflow.StepBuilder: Build a step action with a call.
call(Runnable) - Method in class akka.javasdk.workflow.StepBuilder: Build a step action with a call.
call(Supplier<Output>) - Method in class akka.javasdk.workflow.StepBuilder: Build a step action with a call.
callFunc - Variable in class akka.javasdk.workflow.Workflow.AsyncCallStep
callFunc - Variable in class akka.javasdk.workflow.Workflow.CallStep
callInputClass - Variable in class akka.javasdk.workflow.Workflow.AsyncCallStep
callInputClass - Variable in class akka.javasdk.workflow.Workflow.CallStep
CallStep(String, Class<CallInput>, Function<CallInput, CallOutput>, Class<CallOutput>, Function<CallOutput, Workflow.Effect.TransitionalEffect<Void>>) - Constructor for class akka.javasdk.workflow.Workflow.CallStep: Not for direct user construction, instances are created through the workflow DSL
cancel(String) - Method in interface akka.javasdk.timer.TimerScheduler: Deprecated, for removal: This API element is subject to removal in a future version.
User TimerScheduler.deleteAsync(String) instead.
claim() - Element in annotation interface akka.javasdk.annotations.JWT.StaticClaim: The claim name needs to be a hardcoded literal (e.g.
clear() - Method in record class akka.javasdk.agent.SessionMemoryEntity.State
clear() - Method in interface akka.javasdk.Metadata: Clear all metadata entries.
clearDatacontenttype() - Method in interface akka.javasdk.CloudEvent: Clear the data content type of this CloudEvent, if set.
clearDataschema() - Method in interface akka.javasdk.CloudEvent: Clear the data schema of this CloudEvent, if set.
clearSequence() - Method in interface akka.javasdk.CloudEvent: Clear the sequence of this CloudEvent, if set.
clearSequenceType() - Method in interface akka.javasdk.CloudEvent: Clear the sequence type of this CloudEvent, if set.
clearSubject() - Method in interface akka.javasdk.CloudEvent: Clear the subject of this CloudEvent, if set.
clearTime() - Method in interface akka.javasdk.CloudEvent: Clear the time of this CloudEvent, if set.
ClosedWorld - Enum constant in enum class akka.javasdk.annotations.mcp.ToolAnnotation: The tool's domain of interaction is closed.
CloudEvent - Interface in akka.javasdk: CloudEvent representation of Metadata.
commandContext() - Method in class akka.javasdk.eventsourcedentity.EventSourcedEntity: Provides access to additional context and metadata for the current command being processed.
commandContext() - Method in class akka.javasdk.keyvalueentity.KeyValueEntity: Provides access to additional context and metadata for the current command being processed.
commandContext() - Method in class akka.javasdk.timedaction.TimedAction: Additional context and metadata for a message handler.
commandContext() - Method in class akka.javasdk.workflow.Workflow: Additional context and metadata for a command handler.
CommandContext - Interface in akka.javasdk.eventsourcedentity: Context information available to Event Sourced Entity command handlers during command processing.
CommandContext - Interface in akka.javasdk.keyvalueentity: Context information available to Key Value Entity command handlers during command processing.
CommandContext - Interface in akka.javasdk.timedaction: Context for action calls.
CommandContext - Interface in akka.javasdk.workflow: A value based workflow command context.
CommandEnvelope<T> - Interface in akka.javasdk.timedaction: A command envelope.
Command Handlers - Search tag in class akka.javasdk.eventsourcedentity.EventSourcedEntity: Section
Command Handlers - Search tag in class akka.javasdk.keyvalueentity.KeyValueEntity: Section
commandId() - Method in interface akka.javasdk.eventsourcedentity.CommandContext: Deprecated.
This method is no longer used and will be removed in a future version
commandId() - Method in interface akka.javasdk.keyvalueentity.CommandContext: Deprecated.
This method is no longer used and will be removed in a future version
commandId() - Method in interface akka.javasdk.workflow.CommandContext: Deprecated.
not used anymore
commandName() - Method in interface akka.javasdk.eventsourcedentity.CommandContext: Returns the name of the command currently being executed.
commandName() - Method in interface akka.javasdk.keyvalueentity.CommandContext: Returns the name of the command currently being executed.
commandName() - Method in interface akka.javasdk.workflow.CommandContext: The name of the command being executed.
compactHistory(SessionMemoryEntity.CompactionCmd) - Method in class akka.javasdk.agent.SessionMemoryEntity
CompactionCmd(SessionMessage.UserMessage, SessionMessage.AiMessage, long) - Constructor for record class akka.javasdk.agent.SessionMemoryEntity.CompactionCmd: Creates an instance of a CompactionCmd record class.
ComponentClient - Interface in akka.javasdk.client: Utility to send requests to other components by composing a call that can be executed by the runtime.
ComponentDeferredMethodRef<R> - Interface in akka.javasdk.client: 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)
ComponentDeferredMethodRef1<A1,R> - Interface in akka.javasdk.client: 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)
componentId() - Method in record class akka.javasdk.agent.SessionMemoryEntity.Event.AiMessageAdded: Returns the value of the componentId record component.
componentId() - Method in record class akka.javasdk.agent.SessionMemoryEntity.Event.ToolResponseMessageAdded: Returns the value of the componentId record component.
componentId() - Method in record class akka.javasdk.agent.SessionMemoryEntity.Event.UserMessageAdded: Returns the value of the componentId record component.
componentId() - Method in record class akka.javasdk.agent.SessionMessage.AiMessage: Returns the value of the componentId record component.
componentId() - Method in record class akka.javasdk.agent.SessionMessage.ToolCallResponse: Returns the value of the componentId record component.
componentId() - Method in record class akka.javasdk.agent.SessionMessage.UserMessage: Returns the value of the componentId record component.
ComponentId - Annotation Interface in akka.javasdk.annotations: Assign a type identifier to a component (required for all component types aside from Endpoints).
ComponentInvokeOnlyMethodRef<R> - Interface in akka.javasdk.client: Zero argument component call representation, not executed until invoked.
ComponentInvokeOnlyMethodRef1<A1,R> - Interface in akka.javasdk.client: One argument component call representation, not executed until invoked.
ComponentMethodRef<R> - Interface in akka.javasdk.client: 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)
ComponentMethodRef1<A1,R> - Interface in akka.javasdk.client: 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)
ComponentStreamMethodRef<R> - Interface in akka.javasdk.client: Zero argument component call representation, not executed until stream is materialized.
ComponentStreamMethodRef1<A1,R> - Interface in akka.javasdk.client: One argument component call representation, not executed until stream is materialized.
configPath() - Method in record class akka.javasdk.agent.MemoryProvider.FromConfig: Returns the value of the configPath record component.
configPath() - Method in record class akka.javasdk.agent.ModelProvider.FromConfig: Returns the value of the configPath record component.
Consume - Annotation Interface in akka.javasdk.annotations: Annotation for providing ways to consume a stream of messages from Entities, other services, or message broker topics.
Consume.FromEventSourcedEntity - Annotation Interface in akka.javasdk.annotations: Annotation for consuming events from an EventSourcedEntity.
Consume.FromKeyValueEntity - Annotation Interface in akka.javasdk.annotations: Annotation for consuming state updates from a KeyValueEntity.
Consume.FromServiceStream - Annotation Interface in akka.javasdk.annotations: Annotation for consuming messages from another service.
Consume.FromTopic - Annotation Interface in akka.javasdk.annotations: Annotation for consuming messages from a topic (i.e PubSub or Kafka topic).
Consume.FromWorkflow - Annotation Interface in akka.javasdk.annotations: Annotation for consuming state updates from a Workflow.
Consumer - Class in akka.javasdk.consumer: Consumers are stateless components that can be used to implement different uses cases, such as:
Consumer() - Constructor for class akka.javasdk.consumer.Consumer
Consumer.Effect - Interface in akka.javasdk.consumer: An Effect is a description of what the runtime needs to do after the command is handled.
Consumer.Effect.Builder - Interface in akka.javasdk.consumer: Construct the effect that is returned by the message handler.
consumerGroup() - Element in annotation interface akka.javasdk.annotations.Consume.FromServiceStream: In case you need to consume the same stream multiple times, each subscription should have a unique consumer group.
consumerGroup() - Element in annotation interface akka.javasdk.annotations.Consume.FromTopic: Assign the consumer group name to be used on the broker.
content() - Method in record class akka.javasdk.agent.SessionMemoryEntity.Event.ToolResponseMessageAdded: Returns the value of the content record component.
context() - Method in class akka.javasdk.agent.Agent: Additional context and metadata for a command handler.
Context - Interface in akka.javasdk: Root class of all contexts.
createChatModel() - Method in interface akka.javasdk.agent.ModelProvider.Custom
created() - Static method in class akka.javasdk.http.HttpResponses: Creates a 201 CREATED response.
created(Object) - Static method in class akka.javasdk.http.HttpResponses: Creates a 201 CREATED response with an application/json body The passed Object is serialized to json using the application's default Jackson serializer.
created(Object, String) - Static method in class akka.javasdk.http.HttpResponses: Creates a 201 CREATED response with an application/json body and a location header.
created(String) - Static method in class akka.javasdk.http.HttpResponses: Creates a 201 CREATED response with a text/plain body.
created(String, String) - Static method in class akka.javasdk.http.HttpResponses: Creates a 201 CREATED response with a text/plain body and a location header.
createDependencyProvider() - Method in interface akka.javasdk.ServiceSetup: Invoked once before the service is started, to create a dependency provider.
createSingleTimer(String, Duration, int, DeferredCall<I, O>) - Method in interface akka.javasdk.timer.TimerScheduler: Schedule a single timer.
createSingleTimer(String, Duration, DeferredCall<I, O>) - Method in interface akka.javasdk.timer.TimerScheduler: Schedule a single timer.
createSingleTimerAsync(String, Duration, int, DeferredCall<I, O>) - Method in interface akka.javasdk.timer.TimerScheduler: Schedule a single timer.
createSingleTimerAsync(String, Duration, DeferredCall<I, O>) - Method in interface akka.javasdk.timer.TimerScheduler: Schedule a single timer.
createStreamingChatModel() - Method in interface akka.javasdk.agent.ModelProvider.Custom
currentSizeInBytes() - Method in record class akka.javasdk.agent.SessionMemoryEntity.State: Returns the value of the currentSizeInBytes record component.
currentState() - Method in class akka.javasdk.eventsourcedentity.EventSourcedEntity: Returns the current state of this entity as derived from all persisted events.
currentState() - Method in class akka.javasdk.keyvalueentity.KeyValueEntity: Returns the current state of this entity as stored in memory.
currentState() - Method in class akka.javasdk.workflow.Workflow: Returns the state as currently stored.
currentVersion() - Method in class akka.javasdk.JsonMigration: Define current version, that is, the value used when serializing new data.
custom(ModelProvider.Custom) - Static method in interface akka.javasdk.agent.ModelProvider
custom(SessionMemory) - Static method in interface akka.javasdk.agent.MemoryProvider: Creates a custom memory provider using the specified SessionMemory implementation.
CustomMemoryProvider(SessionMemory) - Constructor for record class akka.javasdk.agent.MemoryProvider.CustomMemoryProvider: Creates an instance of a CustomMemoryProvider record class.

D

datacontenttype() - Method in interface akka.javasdk.CloudEvent: The data content type of this CloudEvent.
dataschema() - Method in interface akka.javasdk.CloudEvent: The data schema of this CloudEvent.
decodeJson(Class<T>, byte[]) - Static method in class akka.javasdk.JsonSupport: Decode the given bytes to an instance of T using Jackson.
decodeJson(Class<T>, ByteString) - Static method in class akka.javasdk.JsonSupport: Decode the given bytes to an instance of T using Jackson.
decodeJson(Class<T>, Any) - Static method in class akka.javasdk.JsonSupport: Deprecated.
Protobuf Any with JSON is not supported
decodeJson(Class<T>, String, Any) - Static method in class akka.javasdk.JsonSupport: Deprecated.
Protobuf Any with JSON is not supported
decodeJsonCollection(Class<T>, Class<C>, byte[]) - Static method in class akka.javasdk.JsonSupport: Deprecated.
was only intended for internal use
decodeJsonCollection(Class<T>, Class<C>, ByteString) - Static method in class akka.javasdk.JsonSupport: Deprecated.
was only intended for internal use
decodeJsonCollection(Class<T>, Class<C>, Any) - Static method in class akka.javasdk.JsonSupport: Deprecated.
Protobuf Any with JSON is not supported
defaultStepRecoverStrategy(Workflow.RecoverStrategy) - Method in class akka.javasdk.workflow.Workflow.WorkflowDef: Define a default step recovery strategy.
defaultStepTimeout(Duration) - Method in class akka.javasdk.workflow.Workflow.WorkflowDef: Define a default step timeout.
deferred() - Method in interface akka.javasdk.client.ComponentDeferredMethodRef
deferred(A1) - Method in interface akka.javasdk.client.ComponentDeferredMethodRef1
DeferredCall<I,O> - Interface in akka.javasdk: Represents a call to another component that can be persisted and invoked later.
definition() - Method in class akka.javasdk.workflow.Workflow
delete() - Method in class akka.javasdk.agent.PromptTemplate: Delete the prompt template.
delete() - Method in class akka.javasdk.agent.SessionMemoryEntity
delete() - Method in interface akka.javasdk.workflow.Workflow.Effect.Builder: Finish and delete the workflow execution.
delete() - Method in interface akka.javasdk.workflow.Workflow.Effect.PersistenceEffectBuilder: Finish and delete the workflow execution.
delete(String) - Method in interface akka.javasdk.timer.TimerScheduler: Delete an existing timer.
Delete - Annotation Interface in akka.javasdk.annotations.http: Annotation to mark a method as handling HTTP DELETE requests.
DELETE(String) - Method in interface akka.javasdk.http.HttpClient
deleteAsync(String) - Method in interface akka.javasdk.timer.TimerScheduler: Delete an existing timer.
Deleted() - Constructor for record class akka.javasdk.agent.PromptTemplate.Event.Deleted: Creates an instance of a Deleted record class.
Deleted(Instant) - Constructor for record class akka.javasdk.agent.SessionMemoryEntity.Event.Deleted: Creates an instance of a Deleted record class.
deleteEntity() - Method in interface akka.javasdk.eventsourcedentity.EventSourcedEntity.Effect.OnSuccessBuilder: Delete the entity.
deleteEntity() - Method in interface akka.javasdk.keyvalueentity.KeyValueEntity.Effect.Builder: Marks the entity for deletion.
DeleteHandler - Annotation Interface in akka.javasdk.annotations
deleteRow() - Method in interface akka.javasdk.view.TableUpdater.Effect.Builder
deny() - Element in annotation interface akka.javasdk.annotations.Acl: After matching an allow rule, an incoming request that has at least one principal that matches a deny rule will be denied.
denyCode() - Element in annotation interface akka.javasdk.annotations.Acl: The status code to respond with when access is denied.
DependencyProvider - Interface in akka.javasdk: A factory method to provide additional dependencies to the component implementations.
description() - Method in record class akka.javasdk.agent.AgentRegistry.AgentInfo: Returns the value of the description record component.
description() - Element in annotation interface akka.javasdk.annotations.AgentDescription
description() - Element in annotation interface akka.javasdk.annotations.FunctionTool
description() - Element in annotation interface akka.javasdk.annotations.mcp.McpPrompt
description() - Element in annotation interface akka.javasdk.annotations.mcp.McpResource
description() - Element in annotation interface akka.javasdk.annotations.mcp.McpTool
Description - Annotation Interface in akka.javasdk.annotations: Used to define a human language description for fields and method parameters, such as MCP tool parameters or tool methods.
Destructive - Enum constant in enum class akka.javasdk.annotations.mcp.ToolAnnotation: The tool may perform destructive updates to its environment.
Disabled() - Constructor for record class akka.javasdk.agent.MemoryProvider.Disabled: Creates an instance of a Disabled record class.
disabledComponents() - Method in interface akka.javasdk.ServiceSetup: Provides a set of components that should be disabled from running.
done() - Method in interface akka.javasdk.consumer.Consumer.Effect.Builder: Mark message as processed.
done() - Method in interface akka.javasdk.timedaction.TimedAction.Effect.Builder: Command was processed successfully.
dynamicCall(String) - Method in interface akka.javasdk.client.AgentClientInSession: Agents can be called based on the id without knowing the exact agent class or lambda of the agent method by using the {dynamicCall} of the component client.
DynamicMethodRef<A1,R> - Interface in akka.javasdk.client: Zero or one argument component call representation, not executed until invoked.

E

effects() - Method in class akka.javasdk.agent.Agent
effects() - Method in class akka.javasdk.consumer.Consumer
effects() - Method in class akka.javasdk.eventsourcedentity.EventSourcedEntity
effects() - Method in class akka.javasdk.keyvalueentity.KeyValueEntity
effects() - Method in class akka.javasdk.timedaction.TimedAction
effects() - Method in class akka.javasdk.view.TableUpdater
effects() - Method in class akka.javasdk.workflow.Workflow
EMPTY - Static variable in record class akka.javasdk.agent.SessionHistory
EMPTY - Static variable in interface akka.javasdk.Metadata: An empty Metadata object.
emptyRow() - Method in class akka.javasdk.view.TableUpdater: The default implementation of this method returns null.
emptyState() - Method in class akka.javasdk.agent.SessionMemoryEntity
emptyState() - Method in class akka.javasdk.eventsourcedentity.EventSourcedEntity: Returns the initial empty state object for this entity.
emptyState() - Method in class akka.javasdk.keyvalueentity.KeyValueEntity: Returns the initial empty state object for this entity.
emptyState() - Method in class akka.javasdk.workflow.Workflow: Returns the initial empty state object.
encodeDynamicCollectionToAkkaByteString(String, Collection<?>) - Static method in class akka.javasdk.JsonSupport: Deprecated.
was only intended for internal use
encodeDynamicToAkkaByteString(String, String) - Static method in class akka.javasdk.JsonSupport: Deprecated.
was only intended for internal use
encodeJson(T) - Static method in class akka.javasdk.JsonSupport: Deprecated.
Protobuf Any with JSON is not supported
encodeJson(T, String) - Static method in class akka.javasdk.JsonSupport: Deprecated.
Protobuf Any with JSON is not supported
encodeToAkkaByteString(T) - Static method in class akka.javasdk.JsonSupport: Encode the given value as JSON using Jackson.
encodeToBytes(T) - Static method in class akka.javasdk.JsonSupport: Deprecated.
Use encodeToAkkaByteString
encodeToString(T) - Static method in class akka.javasdk.JsonSupport: Encode the given value as JSON using Jackson.
end() - Method in interface akka.javasdk.workflow.Workflow.Effect.Builder: Finish the workflow execution.
end() - Method in interface akka.javasdk.workflow.Workflow.Effect.PersistenceEffectBuilder: Finish the workflow execution.
EntityContext - Interface in akka.javasdk: Root context for all contexts that pertain to entities, that is, things that are addressable via an entity id.
entityId() - Method in interface akka.javasdk.EntityContext: The id of the entity that this context is for.
entityId() - Method in interface akka.javasdk.eventsourcedentity.CommandContext: Returns the unique identifier of the entity instance that this command is being executed on.
entityId() - Method in interface akka.javasdk.keyvalueentity.CommandContext: Returns the unique identifier of the entity instance that this command is being executed on.
equals(Object) - Method in record class akka.javasdk.agent.AgentRegistry.AgentInfo: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.agent.MemoryProvider.CustomMemoryProvider: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.agent.MemoryProvider.Disabled: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.agent.MemoryProvider.FromConfig: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.agent.MemoryProvider.LimitedWindowMemoryProvider: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.agent.ModelProvider.Anthropic: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.agent.ModelProvider.FromConfig: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.agent.ModelProvider.GoogleAIGemini: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.agent.ModelProvider.HuggingFace: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.agent.ModelProvider.LocalAI: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.agent.ModelProvider.Ollama: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.agent.ModelProvider.OpenAi: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.agent.PromptTemplate.Event.Deleted: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.agent.PromptTemplate.Event.Updated: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.agent.PromptTemplate.Prompt: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.agent.SessionHistory: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.agent.SessionMemoryEntity.AddInteractionCmd: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.agent.SessionMemoryEntity.CompactionCmd: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.agent.SessionMemoryEntity.Event.AiMessageAdded: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.agent.SessionMemoryEntity.Event.Deleted: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.agent.SessionMemoryEntity.Event.HistoryCleared: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.agent.SessionMemoryEntity.Event.LimitedWindowSet: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.agent.SessionMemoryEntity.Event.ToolResponseMessageAdded: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.agent.SessionMemoryEntity.Event.UserMessageAdded: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.agent.SessionMemoryEntity.GetHistoryCmd: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.agent.SessionMemoryEntity.LimitedWindow: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.agent.SessionMemoryEntity.State: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.agent.SessionMessage.AiMessage: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.agent.SessionMessage.ToolCallRequest: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.agent.SessionMessage.ToolCallResponse: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.agent.SessionMessage.UserMessage: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.http.StrictResponse: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.impl.agent.SessionMemoryClient.MemorySettings: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in class akka.javasdk.Principal.LocalService
error(StatusCode) - Static method in class akka.javasdk.http.HttpException
error(StatusCode, String) - Static method in class akka.javasdk.http.HttpException
error(String) - Method in interface akka.javasdk.agent.Agent.Effect.Builder: Create an error reply without calling the model
error(String) - Method in interface akka.javasdk.agent.Agent.StreamEffect.Builder: Create an error reply without calling the model
error(String) - Method in interface akka.javasdk.eventsourcedentity.EventSourcedEntity.Effect.Builder: Create an error reply.
error(String) - Method in interface akka.javasdk.keyvalueentity.KeyValueEntity.Effect.Builder: Creates an error reply to reject the command and inform the caller of the failure.
error(String) - Method in interface akka.javasdk.timedaction.TimedAction.Effect.Builder: Create an error reply.
error(String) - Method in interface akka.javasdk.workflow.Workflow.Effect.Builder: Create an error reply.
eventContext() - Method in class akka.javasdk.eventsourcedentity.EventSourcedEntity: Provides access to additional context and metadata when handling an event in the EventSourcedEntity.applyEvent(E) method.
EventContext - Interface in akka.javasdk.eventsourcedentity: Context information available when processing events in the EventSourcedEntity.applyEvent(E) method.
Event Handlers - Search tag in class akka.javasdk.eventsourcedentity.EventSourcedEntity: Section
eventName() - Method in interface akka.javasdk.view.UpdateContext: The name of the event being handled.
EventSourcedEntity<S,E> - Class in akka.javasdk.eventsourcedentity: Event Sourced Entities are stateful components that persist changes as events in a journal rather than storing the current state directly.
EventSourcedEntity() - Constructor for class akka.javasdk.eventsourcedentity.EventSourcedEntity
EventSourcedEntity.Effect<T> - Interface in akka.javasdk.eventsourcedentity: An Effect describes the actions that the Akka runtime should perform after a command handler completes.
EventSourcedEntity.Effect.Builder<S,E> - Interface in akka.javasdk.eventsourcedentity: Construct the effect that is returned by the command handler.
EventSourcedEntity.Effect.OnSuccessBuilder<S> - Interface in akka.javasdk.eventsourcedentity
EventSourcedEntity.ReadOnlyEffect<T> - Interface in akka.javasdk.eventsourcedentity: An effect that is known to be read only and does not update the state of the entity.
EventSourcedEntityClient - Interface in akka.javasdk.client: Not for user extension
EventSourcedEntityContext - Interface in akka.javasdk.eventsourcedentity: Context information available during Event Sourced Entity construction and initialization.
Event Sourcing Model - Search tag in class akka.javasdk.eventsourcedentity.EventSourcedEntity: Section
eventSubject() - Method in interface akka.javasdk.consumer.MessageContext: The origin subject of the CloudEvent.
eventSubject() - Method in interface akka.javasdk.view.UpdateContext: The origin subject of the CloudEvent.
Example Implementation - Search tag in class akka.javasdk.eventsourcedentity.EventSourcedEntity: Section
Example Implementation - Search tag in class akka.javasdk.keyvalueentity.KeyValueEntity: Section
expirationTime() - Method in interface akka.javasdk.JwtClaims: Get the expiration time, that is, the exp claim, as described in RFC 7519 section 4.1.4.

F

failoverStepInput - Variable in class akka.javasdk.workflow.Workflow.RecoverStrategy
failoverStepName - Variable in class akka.javasdk.workflow.Workflow.RecoverStrategy
failoverTo(String) - Static method in class akka.javasdk.workflow.Workflow.RecoverStrategy: In case of a step failure don't retry but transition to a given step name.
failoverTo(String) - Method in class akka.javasdk.workflow.Workflow.RecoverStrategy.MaxRetries: Once max retries is exceeded, transition to a given step name.
failoverTo(String, Workflow.RecoverStrategy.MaxRetries) - Method in class akka.javasdk.workflow.Workflow.WorkflowDef: Define a failover step name after workflow timeout.
failoverTo(String, I, Workflow.RecoverStrategy.MaxRetries) - Method in class akka.javasdk.workflow.Workflow.WorkflowDef: Define a failover step name after workflow timeout.
failoverTo(String, T) - Static method in class akka.javasdk.workflow.Workflow.RecoverStrategy: In case of a step failure don't retry but transition to a given step name with the input parameter.
failoverTo(String, T) - Method in class akka.javasdk.workflow.Workflow.RecoverStrategy.MaxRetries: Once max retries is exceeded, transition to a given step name with the input parameter.
findByName(String) - Method in class akka.javasdk.workflow.Workflow.WorkflowDef
forAgent() - Method in interface akka.javasdk.client.ComponentClient: Select Agent as a call target component.
forbidden() - Static method in class akka.javasdk.http.HttpException
forbidden(String) - Static method in class akka.javasdk.http.HttpException
forEventSourcedEntity(String) - Method in interface akka.javasdk.client.ComponentClient: Select EventSourcedEntity as a call target component.
forKeyValueEntity(String) - Method in interface akka.javasdk.client.ComponentClient: Select KeyValueEntity as a call target component.
forTimedAction() - Method in interface akka.javasdk.client.ComponentClient: Select TimedAction as a call target component.
forView() - Method in interface akka.javasdk.client.ComponentClient: Select View as a call target component.
forWorkflow(String) - Method in interface akka.javasdk.client.ComponentClient: Select Workflow as a call target component.
fromConfig() - Static method in interface akka.javasdk.agent.MemoryProvider: Creates a configuration-based memory provider based on configuration defaults.
fromConfig() - Static method in interface akka.javasdk.agent.ModelProvider: Creates a model provider from the default configuration path.
fromConfig(Config) - Static method in record class akka.javasdk.agent.ModelProvider.Anthropic
fromConfig(Config) - Static method in record class akka.javasdk.agent.ModelProvider.GoogleAIGemini
fromConfig(Config) - Static method in record class akka.javasdk.agent.ModelProvider.HuggingFace
fromConfig(Config) - Static method in record class akka.javasdk.agent.ModelProvider.LocalAI
fromConfig(Config) - Static method in record class akka.javasdk.agent.ModelProvider.Ollama
fromConfig(Config) - Static method in record class akka.javasdk.agent.ModelProvider.OpenAi
fromConfig(String) - Static method in interface akka.javasdk.agent.MemoryProvider: Creates a memory provider based on configuration settings.
fromConfig(String) - Static method in interface akka.javasdk.agent.ModelProvider: Creates a model provider from the specified configuration path.
FromConfig(String) - Constructor for record class akka.javasdk.agent.MemoryProvider.FromConfig: Creates an instance of a FromConfig record class.
FromConfig(String) - Constructor for record class akka.javasdk.agent.ModelProvider.FromConfig: Creates an instance of a FromConfig record class.
fromServer(String) - Static method in interface akka.javasdk.agent.RemoteMcpTools
fromService(String) - Static method in interface akka.javasdk.agent.RemoteMcpTools
FunctionTool - Annotation Interface in akka.javasdk.annotations: Annotation to expose methods as function tools that can be invoked by AI agents.

G

get() - Method in class akka.javasdk.agent.PromptTemplate: Get the prompt template.
get() - Method in interface akka.javasdk.Principals: Get the principals associated with this request.
get(String) - Method in interface akka.javasdk.Metadata: Get the string value for the given key, if found.
Get - Annotation Interface in akka.javasdk.annotations.http: Annotation to mark a method as handling HTTP GET requests.
GET(String) - Method in interface akka.javasdk.http.HttpClient
getAll(String) - Method in interface akka.javasdk.http.QueryParams: Returns the value of all parameters with the given key.
getAll(String) - Method in interface akka.javasdk.Metadata: Get all the string values for a given key.
getAll(String, Function<String, T>) - Method in interface akka.javasdk.http.QueryParams: Returns the value of all parameters with the given key using mapper function.
getAllKeys() - Method in interface akka.javasdk.Metadata: Get all the keys for all the entries.
getBinary(String) - Method in interface akka.javasdk.Metadata: Get the binary value for the given key, if found.
getBinaryAll(String) - Method in interface akka.javasdk.Metadata: Get all the binary values for a given key.
getBinaryValue() - Method in interface akka.javasdk.Metadata.MetadataEntry: Deprecated.
binary not supported, use Metadata.MetadataEntry.getValue()
getBoolean(String) - Method in interface akka.javasdk.http.QueryParams: Returns the Boolean value of the first parameter with the given key if it exists.
getBoolean(String) - Method in interface akka.javasdk.JwtClaims: Get the boolean claim with the given name.
getBooleanList(String) - Method in interface akka.javasdk.JwtClaims: Get the boolean list claim with the given name.
getDependency(Class<T>) - Method in interface akka.javasdk.DependencyProvider: Get a dependency for a given class.
getDouble(String) - Method in interface akka.javasdk.http.QueryParams: Returns the Double value of the first parameter with the given key if it exists.
getDouble(String) - Method in interface akka.javasdk.JwtClaims: Get the double claim with the given name.
getDoubleList(String) - Method in interface akka.javasdk.JwtClaims: Get the double list claim with the given name.
getEndpoint() - Method in exception class akka.javasdk.agent.McpToolCallExecutionException: Returns the MCP endpoint where the failure occurred.
getFailoverMaxRetries() - Method in class akka.javasdk.workflow.Workflow.WorkflowDef
getFailoverStepInput() - Method in class akka.javasdk.workflow.Workflow.WorkflowDef
getFailoverStepName() - Method in class akka.javasdk.workflow.Workflow.WorkflowDef
getHistory(SessionMemoryEntity.GetHistoryCmd) - Method in class akka.javasdk.agent.SessionMemoryEntity
getHistory(String) - Method in interface akka.javasdk.agent.SessionMemory: Retrieves the complete session history for the specified session.
getHistory(String) - Method in class akka.javasdk.impl.agent.SessionMemoryClient
GetHistoryCmd(Optional<Integer>) - Constructor for record class akka.javasdk.agent.SessionMemoryEntity.GetHistoryCmd: Creates an instance of a GetHistoryCmd record class.
getInteger(String) - Method in interface akka.javasdk.http.QueryParams: Returns the Integer value of the first parameter with the given key if it exists.
getInteger(String) - Method in interface akka.javasdk.JwtClaims: Get the integer claim with the given name.
getIntegerList(String) - Method in interface akka.javasdk.JwtClaims: Get the integer list claim with the given name.
getJwtClaims() - Method in interface akka.javasdk.grpc.GrpcRequestContext
getJwtClaims() - Method in interface akka.javasdk.http.RequestContext
getJwtClaims() - Method in interface akka.javasdk.mcp.McpRequestContext
getKey() - Method in interface akka.javasdk.Metadata.MetadataEntry: The key for the metadata entry.
getLocalService() - Method in interface akka.javasdk.Principals: Get the service that invoked this call, if any.
getLong(String) - Method in interface akka.javasdk.http.QueryParams: Returns the Long value of the first parameter with the given key if it exists.
getLong(String) - Method in interface akka.javasdk.JwtClaims: Get the long claim with the given name.
getLongList(String) - Method in interface akka.javasdk.JwtClaims: Get the long list claim with the given name.
getMaxRetries() - Method in class akka.javasdk.workflow.Workflow.RecoverStrategy.MaxRetries
getName() - Method in class akka.javasdk.Principal.LocalService
getNumericDate(String) - Method in interface akka.javasdk.JwtClaims: Get the numeric data claim with the given name.
getNumericDateList(String) - Method in interface akka.javasdk.JwtClaims: Get the numeric date list claim with the given name.
getObject(String) - Method in interface akka.javasdk.JwtClaims: Get the object claim with the given name.
getObjectList(String) - Method in interface akka.javasdk.JwtClaims: Get the object list claim with the given name.
getObjectMapper() - Static method in class akka.javasdk.JsonSupport: The Jackson ObjectMapper that is used for encoding and decoding JSON for HTTP endpoints and HTTP requests.
getOptional() - Method in class akka.javasdk.agent.PromptTemplate: Get the prompt template.
getPrincipals() - Method in interface akka.javasdk.grpc.GrpcRequestContext: Get the principals associated with this request.
getPrincipals() - Method in interface akka.javasdk.http.RequestContext: Get the principals associated with this request.
getPrincipals() - Method in interface akka.javasdk.mcp.McpRequestContext: Get the principals associated with this request.
getPromptTemplate(String) - Method in class akka.javasdk.impl.agent.PromptTemplateClient
getRawJson() - Method in exception class akka.javasdk.agent.JsonParsingException
getStepConfigs() - Method in class akka.javasdk.workflow.Workflow.WorkflowDef
getStepRecoverStrategy() - Method in class akka.javasdk.workflow.Workflow.WorkflowDef
getSteps() - Method in class akka.javasdk.workflow.Workflow.WorkflowDef
getStepTimeout() - Method in class akka.javasdk.workflow.Workflow.WorkflowDef
getString(String) - Method in interface akka.javasdk.http.QueryParams: Returns the value of the first parameter with the given key if it exists.
getString(String) - Method in interface akka.javasdk.JwtClaims: Get the string claim with the given name.
getStringList(String) - Method in interface akka.javasdk.JwtClaims: Get the string list claim with the given name.
getToolName() - Method in exception class akka.javasdk.agent.McpToolCallExecutionException: Returns the name of the MCP tool that failed to execute.
getToolName() - Method in exception class akka.javasdk.agent.ToolCallExecutionException: Returns the name of the tool that failed to execute.
getValue() - Method in interface akka.javasdk.Metadata.MetadataEntry: The string value for the metadata entry.
getWorkflowTimeout() - Method in class akka.javasdk.workflow.Workflow.WorkflowDef
googleAiGemini() - Static method in interface akka.javasdk.agent.ModelProvider: Settings for the Google AI Gemini Large Language Model provider.
GoogleAIGemini(String, String, Double, Double, int) - Constructor for record class akka.javasdk.agent.ModelProvider.GoogleAIGemini: Creates an instance of a GoogleAIGemini record class.
grpcClientFor(Class<T>, String) - Method in interface akka.javasdk.grpc.GrpcClientProvider: Returns a gRPC client to interact with the specified service.
GrpcClientProvider - Interface in akka.javasdk.grpc: Not for user extension, instances are available through injection in selected component types.
GrpcEndpoint - Annotation Interface in akka.javasdk.annotations: Mark a class to be made available as a gRPC endpoint.
GrpcRequestContext - Interface in akka.javasdk.grpc: Not for user extension, can be injected as constructor parameter into gRPC endpoint components

H

has(String) - Method in interface akka.javasdk.Metadata: Check whether this metadata has a entry for the given key.
hasClaims() - Method in interface akka.javasdk.JwtClaims: Does this request have any claims that have been validated?
hashCode() - Method in record class akka.javasdk.agent.AgentRegistry.AgentInfo: Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.agent.MemoryProvider.CustomMemoryProvider: Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.agent.MemoryProvider.Disabled: Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.agent.MemoryProvider.FromConfig: Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.agent.MemoryProvider.LimitedWindowMemoryProvider: Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.agent.ModelProvider.Anthropic: Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.agent.ModelProvider.FromConfig: Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.agent.ModelProvider.GoogleAIGemini: Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.agent.ModelProvider.HuggingFace: Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.agent.ModelProvider.LocalAI: Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.agent.ModelProvider.Ollama: Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.agent.ModelProvider.OpenAi: Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.agent.PromptTemplate.Event.Deleted: Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.agent.PromptTemplate.Event.Updated: Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.agent.PromptTemplate.Prompt: Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.agent.SessionHistory: Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.agent.SessionMemoryEntity.AddInteractionCmd: Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.agent.SessionMemoryEntity.CompactionCmd: Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.agent.SessionMemoryEntity.Event.AiMessageAdded: Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.agent.SessionMemoryEntity.Event.Deleted: Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.agent.SessionMemoryEntity.Event.HistoryCleared: Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.agent.SessionMemoryEntity.Event.LimitedWindowSet: Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.agent.SessionMemoryEntity.Event.ToolResponseMessageAdded: Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.agent.SessionMemoryEntity.Event.UserMessageAdded: Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.agent.SessionMemoryEntity.GetHistoryCmd: Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.agent.SessionMemoryEntity.LimitedWindow: Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.agent.SessionMemoryEntity.State: Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.agent.SessionMessage.AiMessage: Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.agent.SessionMessage.ToolCallRequest: Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.agent.SessionMessage.ToolCallResponse: Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.agent.SessionMessage.UserMessage: Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.http.StrictResponse: Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.impl.agent.SessionMemoryClient.MemorySettings: Returns a hash code value for this object.
hashCode() - Method in class akka.javasdk.Principal.LocalService
hasLocalOrigin() - Method in interface akka.javasdk.OriginAwareContext: Returns true if this message originated in the same region where it is currently being processed.
hasRole(String) - Method in record class akka.javasdk.agent.AgentRegistry.AgentInfo
HistoryCleared() - Constructor for record class akka.javasdk.agent.SessionMemoryEntity.Event.HistoryCleared: Creates an instance of a HistoryCleared record class.
historyLimit() - Method in record class akka.javasdk.impl.agent.SessionMemoryClient.MemorySettings: Returns the value of the historyLimit record component.
historySizeInBytes() - Method in record class akka.javasdk.agent.SessionMemoryEntity.Event.AiMessageAdded: Returns the value of the historySizeInBytes record component.
HttpClient - Interface in akka.javasdk.http: HTTP client for making outbound HTTP requests to other services.
httpClientFor(String) - Method in interface akka.javasdk.http.HttpClientProvider: Returns a HttpClient to interact with the specified HTTP service.
HttpClientProvider - Interface in akka.javasdk.http: Provider for HTTP clients to interact with other services over HTTP.
HttpEndpoint - Annotation Interface in akka.javasdk.annotations.http: Annotation to mark a class as an HTTP endpoint that exposes RESTful APIs.
HttpException - Class in akka.javasdk.http: Factory class for creating HTTP exceptions that result in specific HTTP error responses.
httpResponse() - Method in record class akka.javasdk.http.StrictResponse: Returns the value of the httpResponse record component.
HttpResponses - Class in akka.javasdk.http: Factory class for creating common HTTP responses in endpoint methods.
huggingFace() - Static method in interface akka.javasdk.agent.ModelProvider: Settings for the HuggingFace Large Language Model provider.
HuggingFace(String, String, String, double, double, int) - Constructor for record class akka.javasdk.agent.ModelProvider.HuggingFace: Creates an instance of a HuggingFace record class.

I

id() - Method in record class akka.javasdk.agent.AgentRegistry.AgentInfo: Returns the value of the id record component.
id() - Method in record class akka.javasdk.agent.SessionMemoryEntity.Event.ToolResponseMessageAdded: Returns the value of the id record component.
id() - Method in record class akka.javasdk.agent.SessionMessage.ToolCallRequest: Returns the value of the id record component.
id() - Method in record class akka.javasdk.agent.SessionMessage.ToolCallResponse: Returns the value of the id record component.
id() - Element in annotation interface akka.javasdk.annotations.Consume.FromServiceStream: The unique identifier of the stream in the producing service
id() - Element in annotation interface akka.javasdk.annotations.Produce.ServiceStream: Identifier for the event stream.
id() - Method in interface akka.javasdk.CloudEvent: The id of this CloudEvent.
Idempotent - Enum constant in enum class akka.javasdk.annotations.mcp.ToolAnnotation: Calling the tool repeatedly with the same arguments will have no additional effect on the environment.
ignore() - Method in interface akka.javasdk.consumer.Consumer.Effect.Builder: Ignore the current message and proceed with processing the next message
ignore() - Method in interface akka.javasdk.view.TableUpdater.Effect.Builder: Ignore this event (and continue to process the next).
ignoreUnknown() - Element in annotation interface akka.javasdk.annotations.Consume.FromEventSourcedEntity: This option is only available for classes.
ignoreUnknown() - Element in annotation interface akka.javasdk.annotations.Consume.FromServiceStream: When there is no method in the class whose input type matches the event type: if ignoreUnknown is true the event is discarded if false, an Exception is raised
ignoreUnknown() - Element in annotation interface akka.javasdk.annotations.Consume.FromTopic: This option is only available for classes.
Immutable state record - Search tag in class akka.javasdk.eventsourcedentity.EventSourcedEntity: Section
Immutable state record - Search tag in class akka.javasdk.keyvalueentity.KeyValueEntity: Section
Implementation Steps - Search tag in class akka.javasdk.eventsourcedentity.EventSourcedEntity: Section
Implementation Steps - Search tag in class akka.javasdk.keyvalueentity.KeyValueEntity: Section
init(String) - Method in class akka.javasdk.agent.PromptTemplate: Initialize the prompt template.
inputSchema() - Element in annotation interface akka.javasdk.annotations.mcp.McpTool: Normally, the schema is inferred from the input parameters of the tool method.
inSession(String) - Method in interface akka.javasdk.client.AgentClient: The agent participates in a session, which is used for the agent's conversational memory.
instructions() - Element in annotation interface akka.javasdk.annotations.mcp.McpEndpoint
interceptRequest(RemoteMcpTools.ToolInterceptorContext, String) - Method in interface akka.javasdk.agent.RemoteMcpTools.ToolInterceptor: Intercept calls to tools before they are executed, disallowing the call based on the payload can be done by throwing an exception, modifying the payload is also possible.
interceptResponse(RemoteMcpTools.ToolInterceptorContext, String, String) - Method in interface akka.javasdk.agent.RemoteMcpTools.ToolInterceptor: Intercept responses from MCP tools, disallowing the call based on the result can be done by throwing an exception, modifying the result is also possible.
internalServerError() - Static method in class akka.javasdk.http.HttpResponses: Creates a 500 INTERNAL SERVER ERROR response.
internalServerError(String) - Static method in class akka.javasdk.http.HttpResponses: Creates a 500 INTERNAL SERVER ERROR response with a text/plain body.
InternalServerException - Exception Class in akka.javasdk.agent: Exception thrown when there is an internal failure within the agent system.
InternalServerException(String) - Constructor for exception class akka.javasdk.agent.InternalServerException
INTERNET - Enum constant in enum class akka.javasdk.annotations.Acl.Principal: The internet.
INTERNET - Enum constant in enum class akka.javasdk.Principal.Basic
INTERNET - Static variable in interface akka.javasdk.Principal: Abstract principal representing all requests from the internet
invoke() - Method in interface akka.javasdk.client.ComponentInvokeOnlyMethodRef
invoke() - Method in interface akka.javasdk.client.ComponentMethodRef
invoke() - Method in interface akka.javasdk.client.DynamicMethodRef
invoke() - Method in interface akka.javasdk.http.RequestBuilder
invoke(A1) - Method in interface akka.javasdk.client.ComponentInvokeOnlyMethodRef1
invoke(A1) - Method in interface akka.javasdk.client.ComponentMethodRef1
invoke(A1) - Method in interface akka.javasdk.client.DynamicMethodRef
invokeAsync() - Method in interface akka.javasdk.client.ComponentInvokeOnlyMethodRef
invokeAsync() - Method in interface akka.javasdk.client.ComponentMethodRef
invokeAsync() - Method in interface akka.javasdk.client.DynamicMethodRef
invokeAsync() - Method in interface akka.javasdk.http.RequestBuilder
invokeAsync(A1) - Method in interface akka.javasdk.client.ComponentInvokeOnlyMethodRef1
invokeAsync(A1) - Method in interface akka.javasdk.client.ComponentMethodRef1
invokeAsync(A1) - Method in interface akka.javasdk.client.DynamicMethodRef
isAnyLocalService() - Method in interface akka.javasdk.Principals: Whether this request was from any service in the local project.
isBackoffice() - Method in interface akka.javasdk.Principals: Whether this request is a backoffice request.
isBinary() - Method in interface akka.javasdk.Metadata.MetadataEntry: Deprecated.
binary not supported, use Metadata.MetadataEntry.getValue()
isCloudEvent() - Method in interface akka.javasdk.Metadata: Whether this metadata is also a CloudEvent.
isDeleted() - Method in interface akka.javasdk.eventsourcedentity.CommandContext: Returns whether this entity has been marked for deletion.
isDeleted() - Method in class akka.javasdk.eventsourcedentity.EventSourcedEntity: Returns whether this entity has been marked for deletion.
isDeleted() - Method in class akka.javasdk.keyvalueentity.KeyValueEntity: Returns whether this entity has been marked for deletion.
isDeleted() - Method in class akka.javasdk.workflow.Workflow: Returns true if the entity has been deleted.
isEmpty() - Method in record class akka.javasdk.agent.SessionMemoryEntity.State
isInternet() - Method in interface akka.javasdk.Principals: Whether this request was from the internet.
isLocalService(String) - Method in interface akka.javasdk.Principals: Whether this request was from a service in the local project.
isSelf() - Method in interface akka.javasdk.Principals: Whether this is a self request.
issuedAt() - Method in interface akka.javasdk.JwtClaims: Get the issued at, that is, the iat claim, as described in RFC 7519 section 4.1.6.
issuer() - Method in interface akka.javasdk.JwtClaims: Get the issuer, that is, the iss claim, as described in RFC 7519 section 4.1.1.
isText() - Method in interface akka.javasdk.Metadata.MetadataEntry: Whether this entry is a text entry.

J

JsonMigration - Class in akka.javasdk: Allows to specify dedicated strategy for JSON schema evolution.
JsonMigration() - Constructor for class akka.javasdk.JsonMigration
JsonParsingException - Exception Class in akka.javasdk.agent: Exception thrown when there is an error parsing JSON responses from the model.
JsonParsingException(String, Throwable, String) - Constructor for exception class akka.javasdk.agent.JsonParsingException
JsonSupport - Class in akka.javasdk
JWT - Annotation Interface in akka.javasdk.annotations
JWT.JwtMethodMode - Enum Class in akka.javasdk.annotations
JWT.StaticClaim - Annotation Interface in akka.javasdk.annotations: A static claim is a claim that is required to be present on the token, and have a particular value.
JwtClaims - Interface in akka.javasdk: Representation of JWT claims that have been validated and extracted from the bearer token of a request.
jwtId() - Method in interface akka.javasdk.JwtClaims: Get the JWT ID, that is, the jti claim, as described in RFC 7519 section 4.1.7.

K

KeyValueEntity<S> - Class in akka.javasdk.keyvalueentity: Key Value Entities are stateful components that persist their complete state on every change.
KeyValueEntity() - Constructor for class akka.javasdk.keyvalueentity.KeyValueEntity
KeyValueEntity.Effect<T> - Interface in akka.javasdk.keyvalueentity: An Effect describes the actions that the Akka runtime should perform after a command handler completes.
KeyValueEntity.Effect.Builder<S> - Interface in akka.javasdk.keyvalueentity: Builder for constructing effects that describe the actions to be performed after command processing.
KeyValueEntity.Effect.OnSuccessBuilder<S> - Interface in akka.javasdk.keyvalueentity: Builder for chaining a reply after a successful state operation like updateState or deleteEntity.
KeyValueEntity.ReadOnlyEffect<T> - Interface in akka.javasdk.keyvalueentity: A read-only effect that does not modify the entity state.
KeyValueEntityClient - Interface in akka.javasdk.client: Not for user extension
KeyValueEntityContext - Interface in akka.javasdk.keyvalueentity: Context information available during Key Value Entity construction and initialization.

L

lastNMessages() - Method in record class akka.javasdk.agent.SessionMemoryEntity.GetHistoryCmd: Returns the value of the lastNMessages record component.
limitedWindow() - Static method in interface akka.javasdk.agent.MemoryProvider: Creates a limited window memory provider with default settings.
LimitedWindow(int) - Constructor for record class akka.javasdk.agent.SessionMemoryEntity.LimitedWindow: Creates an instance of a LimitedWindow record class.
LimitedWindowMemoryProvider(Optional<Integer>, boolean, boolean) - Constructor for record class akka.javasdk.agent.MemoryProvider.LimitedWindowMemoryProvider: Creates an instance of a LimitedWindowMemoryProvider record class.
LimitedWindowSet(Instant, int) - Constructor for record class akka.javasdk.agent.SessionMemoryEntity.Event.LimitedWindowSet: Creates an instance of a LimitedWindowSet record class.
localAI() - Static method in interface akka.javasdk.agent.ModelProvider: Settings for the Local AI Large Language Model provider.
LocalAI(String, String, Double, Double, int) - Constructor for record class akka.javasdk.agent.ModelProvider.LocalAI: Creates an instance of a LocalAI record class.
localService(String) - Static method in interface akka.javasdk.Principal: Create a local service principal with the given name
LogbackJsonLayout - Class in akka.javasdk.logging: This Logback JSON layout uses the name severity (instead of level).
LogbackJsonLayout() - Constructor for class akka.javasdk.logging.LogbackJsonLayout

M

map(Function<String, T>) - Method in interface akka.javasdk.agent.Agent.Effect.OnSuccessBuilder: Map the String response from the model into a different response type.
map(Function<Result, T>) - Method in interface akka.javasdk.agent.Agent.Effect.MappingResponseBuilder: Map the response from the model into a different response type.
maxNewTokens() - Method in record class akka.javasdk.agent.ModelProvider.HuggingFace: Returns the value of the maxNewTokens record component.
maxOutputTokens() - Method in record class akka.javasdk.agent.ModelProvider.GoogleAIGemini: Returns the value of the maxOutputTokens record component.
maxRetries - Variable in class akka.javasdk.workflow.Workflow.RecoverStrategy
maxRetries - Variable in class akka.javasdk.workflow.Workflow.RecoverStrategy.MaxRetries
maxRetries(int) - Method in class akka.javasdk.workflow.Workflow: Starts defining a recover strategy for the workflow or a specific step.
maxRetries(int) - Static method in class akka.javasdk.workflow.Workflow.RecoverStrategy: Set the number of retires for a failed step, maxRetries equals 0 means that the step won't retry in case of failure.
MaxRetries(int) - Constructor for class akka.javasdk.workflow.Workflow.RecoverStrategy.MaxRetries
maxSizeInBytes() - Method in record class akka.javasdk.agent.SessionMemoryEntity.Event.LimitedWindowSet: Returns the value of the maxSizeInBytes record component.
maxSizeInBytes() - Method in record class akka.javasdk.agent.SessionMemoryEntity.LimitedWindow: Returns the value of the maxSizeInBytes record component.
maxSizeInBytes() - Method in record class akka.javasdk.agent.SessionMemoryEntity.State: Returns the value of the maxSizeInBytes record component.
maxTokens() - Method in record class akka.javasdk.agent.ModelProvider.Anthropic: Returns the value of the maxTokens record component.
maxTokens() - Method in record class akka.javasdk.agent.ModelProvider.LocalAI: Returns the value of the maxTokens record component.
maxTokens() - Method in record class akka.javasdk.agent.ModelProvider.OpenAi: Returns the value of the maxTokens record component.
McpEndpoint - Annotation Interface in akka.javasdk.annotations.mcp: Annotation to mark a class as an MCP (Model Context Protocol) server endpoint.
McpPrompt - Annotation Interface in akka.javasdk.annotations.mcp: Annotation to expose a method as an MCP prompt that clients can fetch and use.
McpRequestContext - Interface in akka.javasdk.mcp: Context information available during MCP endpoint request processing.
McpResource - Annotation Interface in akka.javasdk.annotations.mcp: Annotation to expose a method as an MCP resource that clients can fetch.
McpTool - Annotation Interface in akka.javasdk.annotations.mcp: Annotation to expose a method as an MCP tool that can be called by MCP clients.
McpToolCallExecutionException - Exception Class in akka.javasdk.agent: Exception thrown when an MCP (Model Context Protocol) tool call fails during execution.
McpToolCallExecutionException(String, String, String, Throwable) - Constructor for exception class akka.javasdk.agent.McpToolCallExecutionException
mcpTools(RemoteMcpTools, RemoteMcpTools...) - Method in interface akka.javasdk.agent.Agent.Effect.Builder: Adds tools from one or more remote MCP servers.
mcpTools(RemoteMcpTools, RemoteMcpTools...) - Method in interface akka.javasdk.agent.Agent.StreamEffect.Builder: Adds tools from one or more remote MCP servers.
mcpTools(List<RemoteMcpTools>) - Method in interface akka.javasdk.agent.Agent.Effect.Builder: Adds tools from one or more remote MCP servers.
mcpTools(List<RemoteMcpTools>) - Method in interface akka.javasdk.agent.Agent.StreamEffect.Builder: Adds tools from one or more remote MCP servers.
memory(MemoryProvider) - Method in interface akka.javasdk.agent.Agent.Effect.Builder
memory(MemoryProvider) - Method in interface akka.javasdk.agent.Agent.StreamEffect.Builder
MemoryProvider - Interface in akka.javasdk.agent: Interface for configuring memory management in agent systems.
MemoryProvider.CustomMemoryProvider - Record Class in akka.javasdk.agent: Memory provider that uses a custom SessionMemory implementation.
MemoryProvider.Disabled - Record Class in akka.javasdk.agent: Disabled memory provider, which does not store or retrieve contextual history.
MemoryProvider.FromConfig - Record Class in akka.javasdk.agent: Configuration-based memory provider that reads settings from the specified path.
MemoryProvider.LimitedWindowMemoryProvider - Record Class in akka.javasdk.agent: Memory provider that limits session history based on size or message count.
MemorySettings(boolean, boolean, Optional<Integer>) - Constructor for record class akka.javasdk.impl.agent.SessionMemoryClient.MemorySettings: Creates an instance of a MemorySettings record class.
merge(Metadata) - Method in interface akka.javasdk.Metadata: Merge the given Metadata entries with this Metadata.
message() - Method in record class akka.javasdk.agent.SessionMemoryEntity.Event.AiMessageAdded: Returns the value of the message record component.
message() - Method in record class akka.javasdk.agent.SessionMemoryEntity.Event.UserMessageAdded: Returns the value of the message record component.
message() - Method in interface akka.javasdk.DeferredCall: The message to pass to the call when the call is invoked.
messageContext() - Method in class akka.javasdk.consumer.Consumer: Additional context and metadata for a message handler.
MessageContext - Interface in akka.javasdk.consumer: Context for an incoming message.
MessageEnvelope<T> - Interface in akka.javasdk.consumer: A message envelope.
messages() - Method in record class akka.javasdk.agent.SessionHistory: Returns the value of the messages record component.
messages() - Method in record class akka.javasdk.agent.SessionMemoryEntity.AddInteractionCmd: Returns the value of the messages record component.
messages() - Method in record class akka.javasdk.agent.SessionMemoryEntity.State: Returns the value of the messages record component.
metadata() - Method in interface akka.javasdk.consumer.MessageEnvelope: The metadata associated with the message.
metadata() - Method in interface akka.javasdk.DeferredCall
metadata() - Method in interface akka.javasdk.grpc.GrpcRequestContext
metadata() - Method in interface akka.javasdk.MetadataContext: Get the metadata associated with this context.
metadata() - Method in interface akka.javasdk.timedaction.CommandEnvelope: The metadata associated with the command.
Metadata - Interface in akka.javasdk: Transport specific metadata.
Metadata.MetadataEntry - Interface in akka.javasdk: A metadata entry.
MetadataContext - Interface in akka.javasdk: Context that provides access to metadata.
method(Function<T, Agent.Effect<R>>) - Method in interface akka.javasdk.client.AgentClientInSession: Pass in an Agent command handler method reference, e.g.
method(Function<T, EventSourcedEntity.Effect<R>>) - Method in interface akka.javasdk.client.EventSourcedEntityClient: Pass in an Event Sourced Entity command handler method reference, e.g.
method(Function<T, KeyValueEntity.Effect<R>>) - Method in interface akka.javasdk.client.KeyValueEntityClient: Pass in a Key Value Entity command handler method reference, e.g.
method(Function<T, TimedAction.Effect>) - Method in interface akka.javasdk.client.TimedActionClient: Pass in an Action method reference, e.g.
method(Function<T, View.QueryEffect<R>>) - Method in interface akka.javasdk.client.ViewClient: Pass in a View query method reference, e.g.
method(Function<T, Workflow.Effect<R>>) - Method in interface akka.javasdk.client.WorkflowClient: Pass in a Workflow method reference annotated as a REST endpoint, e.g.
method(Function2<T, A1, Agent.Effect<R>>) - Method in interface akka.javasdk.client.AgentClientInSession: Pass in an Agent command handler method reference, e.g.
method(Function2<T, A1, EventSourcedEntity.Effect<R>>) - Method in interface akka.javasdk.client.EventSourcedEntityClient: Pass in an Event Sourced Entity command handler method reference, e.g.
method(Function2<T, A1, KeyValueEntity.Effect<R>>) - Method in interface akka.javasdk.client.KeyValueEntityClient: Pass in a Key Value Entity command handler method reference, e.g.
method(Function2<T, A1, TimedAction.Effect>) - Method in interface akka.javasdk.client.TimedActionClient: Pass in an Action method reference, e.g.
method(Function2<T, A1, View.QueryEffect<R>>) - Method in interface akka.javasdk.client.ViewClient: Pass in a View query method reference, e.g.
method(Function2<T, A1, Workflow.Effect<R>>) - Method in interface akka.javasdk.client.WorkflowClient: Pass in a Workflow method reference annotated as a REST endpoint, e.g.
Migration - Annotation Interface in akka.javasdk.annotations: Annotation to assign a @JsonMigration implementation for a given class.
mimeType() - Element in annotation interface akka.javasdk.annotations.mcp.McpResource
model(ModelProvider) - Method in interface akka.javasdk.agent.Agent.Effect.Builder: Define the AI model (LLM) to use.
model(ModelProvider) - Method in interface akka.javasdk.agent.Agent.StreamEffect.Builder: Define the AI model (LLM) to use.
ModelException - Exception Class in akka.javasdk.agent: Exception thrown when there is a failure with the AI model.
ModelException(String) - Constructor for exception class akka.javasdk.agent.ModelException
modelId() - Method in record class akka.javasdk.agent.ModelProvider.HuggingFace: Returns the value of the modelId record component.
modelName() - Method in record class akka.javasdk.agent.ModelProvider.Anthropic: Returns the value of the modelName record component.
modelName() - Method in record class akka.javasdk.agent.ModelProvider.GoogleAIGemini: Returns the value of the modelName record component.
modelName() - Method in record class akka.javasdk.agent.ModelProvider.LocalAI: Returns the value of the modelName record component.
modelName() - Method in record class akka.javasdk.agent.ModelProvider.Ollama: Returns the value of the modelName record component.
modelName() - Method in record class akka.javasdk.agent.ModelProvider.OpenAi: Returns the value of the modelName record component.
ModelProvider - Interface in akka.javasdk.agent: Configuration interface for AI model providers used by agents.
ModelProvider.Anthropic - Record Class in akka.javasdk.agent: Settings for the Anthropic Large Language Model provider.
ModelProvider.Custom - Interface in akka.javasdk.agent
ModelProvider.FromConfig - Record Class in akka.javasdk.agent
ModelProvider.GoogleAIGemini - Record Class in akka.javasdk.agent: Settings for the Google AI Gemini Large Language Model provider.
ModelProvider.HuggingFace - Record Class in akka.javasdk.agent
ModelProvider.LocalAI - Record Class in akka.javasdk.agent: Settings for the Local AI Large Language Model provider.
ModelProvider.Ollama - Record Class in akka.javasdk.agent: Settings for the Ollama Large Language Model provider.
ModelProvider.OpenAi - Record Class in akka.javasdk.agent: Settings for the OpenAI Large Language Model provider.
ModelTimeoutException - Exception Class in akka.javasdk.agent: Exception thrown when a request to an AI model or external service times out.
ModelTimeoutException(String) - Constructor for exception class akka.javasdk.agent.ModelTimeoutException
modifyRequest(Function<HttpRequest, HttpRequest>) - Method in interface akka.javasdk.http.RequestBuilder: Transform the request before sending it.
Multi-region Replication - Search tag in class akka.javasdk.eventsourcedentity.EventSourcedEntity: Section
Multi-region Replication - Search tag in class akka.javasdk.keyvalueentity.KeyValueEntity: Section
Mutating - Enum constant in enum class akka.javasdk.annotations.mcp.ToolAnnotation: The tool does modify its environment.

N

name() - Method in record class akka.javasdk.agent.AgentRegistry.AgentInfo: Returns the value of the name record component.
name() - Method in record class akka.javasdk.agent.SessionMemoryEntity.Event.ToolResponseMessageAdded: Returns the value of the name record component.
name() - Method in record class akka.javasdk.agent.SessionMessage.ToolCallRequest: Returns the value of the name record component.
name() - Method in record class akka.javasdk.agent.SessionMessage.ToolCallResponse: Returns the value of the name record component.
name() - Element in annotation interface akka.javasdk.annotations.AgentDescription
name() - Element in annotation interface akka.javasdk.annotations.FunctionTool
name() - Element in annotation interface akka.javasdk.annotations.mcp.McpPrompt
name() - Element in annotation interface akka.javasdk.annotations.mcp.McpResource
name() - Element in annotation interface akka.javasdk.annotations.mcp.McpTool
name() - Method in class akka.javasdk.workflow.Workflow.AsyncCallStep
name() - Method in class akka.javasdk.workflow.Workflow.CallStep
name() - Method in class akka.javasdk.workflow.Workflow.RunnableStep
name() - Method in interface akka.javasdk.workflow.Workflow.Step
noContent() - Static method in class akka.javasdk.http.HttpResponses: Creates a 204 NO CONTENT response.
NoEntryFoundException - Exception Class in akka.javasdk.client: Thrown for a query where the query result would be a single entry but none was found.
NoEntryFoundException(String) - Constructor for exception class akka.javasdk.client.NoEntryFoundException
NonDestructive - Enum constant in enum class akka.javasdk.annotations.mcp.ToolAnnotation: If false, the tool performs only additive updates.
none() - Static method in interface akka.javasdk.agent.MemoryProvider: Disabled memory provider, which does not store or retrieve contextual history.
NonIdempotent - Enum constant in enum class akka.javasdk.annotations.mcp.ToolAnnotation: Calling the tool repeatedly with the same arguments will affect the environment each time.
notBefore() - Method in interface akka.javasdk.JwtClaims: Get the not before, that is, the nbf claim, as described in RFC 7519 section 4.1.5.
notFound() - Static method in class akka.javasdk.http.HttpException
notFound() - Static method in class akka.javasdk.http.HttpResponses: Creates a 404 NOT FOUND response.
notFound(String) - Static method in class akka.javasdk.http.HttpResponses: Creates a 404 NOT FOUND response with a text/plain body.
notImplemented() - Static method in class akka.javasdk.http.HttpException
notImplemented() - Static method in class akka.javasdk.http.HttpResponses: Creates a 501 NOT IMPLEMENTED response.
notImplemented(String) - Static method in class akka.javasdk.http.HttpResponses: Creates a 501 NOT IMPLEMENTED response with a text/plain body.

O

of(StatusCode, ContentType, byte[]) - Static method in class akka.javasdk.http.HttpResponses: Creates an HTTP response with specified status code, content type and body.
of(String, URI, String) - Static method in interface akka.javasdk.CloudEvent: Create a CloudEvent.
of(T) - Static method in interface akka.javasdk.consumer.MessageEnvelope: Create a message.
of(T) - Static method in interface akka.javasdk.timedaction.CommandEnvelope: Create a command envelope.
of(T, Metadata) - Static method in interface akka.javasdk.consumer.MessageEnvelope: Create a message.
of(T, Metadata) - Static method in interface akka.javasdk.timedaction.CommandEnvelope: Create a command envelope.
ok() - Static method in class akka.javasdk.http.HttpResponses: Creates a 200 OK response.
ok(Object) - Static method in class akka.javasdk.http.HttpResponses: Creates a 200 OK response with an application/json body.
ok(String) - Static method in class akka.javasdk.http.HttpResponses: Creates a 200 OK response with a text/plain body.
ollama() - Static method in interface akka.javasdk.agent.ModelProvider: Settings for the Ollama Large Language Model provider.
Ollama(String, String, Double, Double) - Constructor for record class akka.javasdk.agent.ModelProvider.Ollama: Creates an instance of a Ollama record class.
onFailure(Function<Throwable, String>) - Method in interface akka.javasdk.agent.Agent.Effect.OnSuccessBuilder: Handle failures that occur during model processing.
onFailure(Function<Throwable, Result>) - Method in interface akka.javasdk.agent.Agent.Effect.MappingFailureBuilder: Handle failures that occur during model processing.
onFailure(Function<Throwable, Result>) - Method in interface akka.javasdk.agent.Agent.Effect.MappingResponseBuilder: Handle failures that occur during model processing.
onStartup() - Method in interface akka.javasdk.ServiceSetup: The on startup hook is called every time a service instance boots up.
openAi() - Static method in interface akka.javasdk.agent.ModelProvider: Settings for the OpenAI Large Language Model provider.
OpenAi(String, String, String, double, double, int) - Constructor for record class akka.javasdk.agent.ModelProvider.OpenAi: Creates an instance of a OpenAi record class.
OpenWorld - Enum constant in enum class akka.javasdk.annotations.mcp.ToolAnnotation: This tool may interact with an \"open world\" of external entities.
OriginAwareContext - Interface in akka.javasdk
originRegion() - Method in interface akka.javasdk.OriginAwareContext: When available, this method returns the region where a message was first created.

P

parentSpan() - Method in interface akka.javasdk.Tracing: If tracing is enabled, this returns the current parent span, to use for propagating trace parent through third party integrations.
parseBytes(byte[], Class<T>) - Static method in class akka.javasdk.JsonSupport: Deprecated.
Use decodeJson
parseResponseBody(Function<byte[], T>) - Method in interface akka.javasdk.http.RequestBuilder: Converts the response body to the specified type using the provided parser function.
Patch - Annotation Interface in akka.javasdk.annotations.http: Annotation to mark a method as handling HTTP PATCH requests.
PATCH(String) - Method in interface akka.javasdk.http.HttpClient
path() - Element in annotation interface akka.javasdk.annotations.mcp.McpEndpoint
pattern() - Element in annotation interface akka.javasdk.annotations.JWT.StaticClaim: This receives a regex expression (Java flavor) used to match on the incoming claim value.
pause() - Method in interface akka.javasdk.workflow.Workflow.Effect.Builder: Pause the workflow execution and wait for an external input, e.g.
pause() - Method in interface akka.javasdk.workflow.Workflow.Effect.PersistenceEffectBuilder: Pause the workflow execution and wait for an external input, e.g.
payload() - Method in interface akka.javasdk.consumer.MessageEnvelope: The payload of the message.
payload() - Method in interface akka.javasdk.timedaction.CommandEnvelope: The payload of the command.
persist(E) - Method in interface akka.javasdk.eventsourcedentity.EventSourcedEntity.Effect.Builder: Persist a single event.
persist(E, E, E...) - Method in interface akka.javasdk.eventsourcedentity.EventSourcedEntity.Effect.Builder: Persist the passed events.
persistAll(List<? extends E>) - Method in interface akka.javasdk.eventsourcedentity.EventSourcedEntity.Effect.Builder: Persist the passed List of events.
Post - Annotation Interface in akka.javasdk.annotations.http: Annotation to mark a method as handling HTTP POST requests.
POST(String) - Method in interface akka.javasdk.http.HttpClient
principal() - Element in annotation interface akka.javasdk.annotations.Acl.Matcher: A principal matcher that can be specified with no additional configuration.
Principal - Interface in akka.javasdk: A principal associated with a request.
Principal.Basic - Enum Class in akka.javasdk: Basic principals that have no additional configuration.
Principal.LocalService - Class in akka.javasdk: A local service principal.
Principals - Interface in akka.javasdk: The principals associated with a request.
produce(S) - Method in interface akka.javasdk.consumer.Consumer.Effect.Builder: Produce a message.
produce(S, Metadata) - Method in interface akka.javasdk.consumer.Consumer.Effect.Builder: Produce a message with custom Metadata.
Produce - Annotation Interface in akka.javasdk.annotations: Annotation for ways of producing outgoing information.
Produce.ServiceStream - Annotation Interface in akka.javasdk.annotations: Annotation to configure the component to produce an event stream that can be consumed by other services.
Produce.ToTopic - Annotation Interface in akka.javasdk.annotations: Annotation for marking a method as producing information to be published on a PubSub or Kafka topic.
prompt() - Method in record class akka.javasdk.agent.PromptTemplate.Event.Updated: Returns the value of the prompt record component.
Prompt(String) - Constructor for record class akka.javasdk.agent.PromptTemplate.Prompt: Creates an instance of a Prompt record class.
PromptTemplate - Class in akka.javasdk.agent: A built-in Event Sourced Entity for managing dynamic prompt templates with change history.
PromptTemplate() - Constructor for class akka.javasdk.agent.PromptTemplate
PromptTemplate.Event - Interface in akka.javasdk.agent
PromptTemplate.Event.Deleted - Record Class in akka.javasdk.agent
PromptTemplate.Event.Updated - Record Class in akka.javasdk.agent
PromptTemplate.Prompt - Record Class in akka.javasdk.agent
PromptTemplateClient - Class in akka.javasdk.impl.agent: INTERNAL API
PromptTemplateClient(ComponentClient) - Constructor for class akka.javasdk.impl.agent.PromptTemplateClient
Put - Annotation Interface in akka.javasdk.annotations.http: Annotation to mark a method as handling HTTP PUT requests.
PUT(String) - Method in interface akka.javasdk.http.HttpClient

Q

Query - Annotation Interface in akka.javasdk.annotations: Annotation used in the scope of a view for providing the query that will be used to explore data from that view.
queryParams() - Method in interface akka.javasdk.http.RequestContext
QueryParams - Interface in akka.javasdk.http: Interface for accessing HTTP query parameters with type-safe getters.
queryResult() - Method in class akka.javasdk.view.View
queryStreamResult() - Method in class akka.javasdk.view.View

R

RateLimitException - Exception Class in akka.javasdk.agent: Exception thrown when rate limits are exceeded when calling an AI model or external service.
RateLimitException(String) - Constructor for exception class akka.javasdk.agent.RateLimitException
read() - Method in record class akka.javasdk.agent.MemoryProvider.LimitedWindowMemoryProvider: Returns the value of the read record component.
read() - Method in record class akka.javasdk.impl.agent.SessionMemoryClient.MemorySettings: Returns the value of the read record component.
readLast(int) - Method in record class akka.javasdk.agent.MemoryProvider.LimitedWindowMemoryProvider: Creates a new memory provider with an updated history limit.
readLastN() - Method in record class akka.javasdk.agent.MemoryProvider.LimitedWindowMemoryProvider: Returns the value of the readLastN record component.
readOnly() - Method in record class akka.javasdk.agent.MemoryProvider.LimitedWindowMemoryProvider: Creates a read-only version of this memory provider.
ReadOnly - Enum constant in enum class akka.javasdk.annotations.mcp.ToolAnnotation: The tool does not modify its environment.
recoverStrategy - Variable in class akka.javasdk.workflow.Workflow.StepConfig
RecoverStrategy(int, String, Optional<T>) - Constructor for class akka.javasdk.workflow.Workflow.RecoverStrategy
RemoteMcpTools - Interface in akka.javasdk.agent: Configuration for accessing tools from remote Model Context Protocol (MCP) servers.
RemoteMcpTools.ToolInterceptor - Interface in akka.javasdk.agent
RemoteMcpTools.ToolInterceptorContext - Interface in akka.javasdk.agent: Context details about the intercepted MCP tool call.
remove(String) - Method in interface akka.javasdk.Metadata: Remove all metadata entries with the given key.
reply(String) - Method in interface akka.javasdk.agent.Agent.StreamEffect.Builder: Create a message reply without calling the model.
reply(String, Metadata) - Method in interface akka.javasdk.agent.Agent.StreamEffect.Builder: Create a message reply without calling the model.
reply(R) - Method in interface akka.javasdk.workflow.Workflow.Effect.Builder: Create a message reply.
reply(R, Metadata) - Method in interface akka.javasdk.workflow.Workflow.Effect.Builder: Reply after for example updateState.
reply(T) - Method in interface akka.javasdk.agent.Agent.Effect.Builder: Create a message reply without calling the model.
reply(T) - Method in interface akka.javasdk.eventsourcedentity.EventSourcedEntity.Effect.Builder: Create a message reply.
reply(T) - Method in interface akka.javasdk.keyvalueentity.KeyValueEntity.Effect.Builder: Creates a reply message to send back to the caller without updating the entity state.
reply(T, Metadata) - Method in interface akka.javasdk.agent.Agent.Effect.Builder: Create a message reply without calling the model.
reply(T, Metadata) - Method in interface akka.javasdk.eventsourcedentity.EventSourcedEntity.Effect.Builder: Create a message reply.
reply(T, Metadata) - Method in interface akka.javasdk.keyvalueentity.KeyValueEntity.Effect.Builder: Creates a reply message with additional metadata to send back to the caller without updating the entity state.
RequestBuilder<R> - Interface in akka.javasdk.http: A builder for HTTP requests and handling of their responses
requestContext() - Method in class akka.javasdk.grpc.AbstractGrpcEndpoint: Always available from request handling methods, not available from the constructor.
requestContext() - Method in class akka.javasdk.http.AbstractHttpEndpoint: Always available from request handling methods, not available from the constructor.
requestContext() - Method in class akka.javasdk.mcp.AbstractMcpEndpoint: Always available from request handling methods, not available from the constructor.
RequestContext - Interface in akka.javasdk.http: Context information available during HTTP endpoint request processing.
requestHeader(String) - Method in interface akka.javasdk.http.RequestContext
requestHeader(String) - Method in interface akka.javasdk.mcp.McpRequestContext
responseAs(Class<T>) - Method in interface akka.javasdk.agent.Agent.Effect.OnSuccessBuilder: Parse the response from the model into a structured response of a given responseType.
responseBodyAs(Class<T>) - Method in interface akka.javasdk.http.RequestBuilder: Converts the response body to the specified type.
responseBodyAsListOf(Class<T>) - Method in interface akka.javasdk.http.RequestBuilder: Converts the response body as a list of the specified type.
Retries - Interface in akka.javasdk
retry(Callable<T>, int) - Method in interface akka.javasdk.Retries: Retry a given call with a maximum number of retries.
retry(Callable<T>, RetrySettings) - Method in interface akka.javasdk.Retries: Retry a given call.
retryAsync(Callable<CompletionStage<T>>, int) - Method in interface akka.javasdk.Retries: Retry a given call with a maximum number of retries.
retryAsync(Callable<CompletionStage<T>>, RetrySettings) - Method in interface akka.javasdk.Retries: Retry a given call.
role() - Method in record class akka.javasdk.agent.AgentRegistry.AgentInfo: Returns the value of the role record component.
role() - Element in annotation interface akka.javasdk.annotations.AgentDescription
role() - Element in annotation interface akka.javasdk.annotations.mcp.McpPrompt
rowState() - Method in class akka.javasdk.view.TableUpdater: Returns the current state of the row for the subject that is being updated.
runnable - Variable in class akka.javasdk.workflow.Workflow.RunnableStep
RunnableStep(String, Runnable, Supplier<Workflow.Effect.TransitionalEffect<Void>>) - Constructor for class akka.javasdk.workflow.Workflow.RunnableStep: Not for direct user construction, instances are created through the workflow DSL

S

SELF - Enum constant in enum class akka.javasdk.Principal.Basic
SELF - Static variable in interface akka.javasdk.Principal: Abstract principal representing all requests from self
selfRegion() - Method in interface akka.javasdk.Context: Returns the region where this instance is running.
sequence() - Method in interface akka.javasdk.CloudEvent: The sequence of this CloudEvent parsed to Long value.
sequenceNumber() - Method in record class akka.javasdk.agent.SessionHistory: Returns the value of the sequenceNumber record component.
sequenceNumber() - Method in record class akka.javasdk.agent.SessionMemoryEntity.CompactionCmd: Returns the value of the sequenceNumber record component.
sequenceNumber() - Method in interface akka.javasdk.eventsourcedentity.CommandContext: Returns the current sequence number of events in this entity.
sequenceNumber() - Method in interface akka.javasdk.eventsourcedentity.EventContext: Returns the sequence number of the current event being processed.
sequenceString() - Method in interface akka.javasdk.CloudEvent: The sequence of this CloudEvent.
sequenceType() - Method in interface akka.javasdk.CloudEvent: The sequence type of this CloudEvent.
serverName() - Element in annotation interface akka.javasdk.annotations.mcp.McpEndpoint
serverSentEvents(Source<T, ?>) - Static method in class akka.javasdk.http.HttpResponses
serverVersion() - Element in annotation interface akka.javasdk.annotations.mcp.McpEndpoint
service() - Element in annotation interface akka.javasdk.annotations.Acl.Matcher: Match a service principal.
service() - Element in annotation interface akka.javasdk.annotations.Consume.FromServiceStream: The deployed name of the service to consume from, can be the deployed name of another service in the same project or a fully qualified public hostname of a service in a different project.
ServiceSetup - Interface in akka.javasdk: 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.
SessionHistory - Record Class in akka.javasdk.agent
SessionHistory(List<SessionMessage>, long) - Constructor for record class akka.javasdk.agent.SessionHistory: Creates an instance of a SessionHistory record class.
sessionId() - Method in interface akka.javasdk.agent.AgentContext: Returns the session identifier for this agent interaction.
sessionId() - Method in record class akka.javasdk.agent.SessionMemoryEntity.State: Returns the value of the sessionId record component.
sessionMemory() - Method in record class akka.javasdk.agent.MemoryProvider.CustomMemoryProvider: Returns the underlying SessionMemory implementation.
SessionMemory - Interface in akka.javasdk.agent: Interface for managing contextual session history between users and AI models.
SessionMemoryClient - Class in akka.javasdk.impl.agent: INTERNAL USE Not for user extension or instantiation
SessionMemoryClient(ComponentClient, SessionMemoryClient.MemorySettings) - Constructor for class akka.javasdk.impl.agent.SessionMemoryClient
SessionMemoryClient(ComponentClient, Config) - Constructor for class akka.javasdk.impl.agent.SessionMemoryClient
SessionMemoryClient.MemorySettings - Record Class in akka.javasdk.impl.agent
SessionMemoryEntity - Class in akka.javasdk.agent: Built-in Event Sourced Entity that provides persistent session memory for agent interactions with the AI model.
SessionMemoryEntity(Config, EventSourcedEntityContext) - Constructor for class akka.javasdk.agent.SessionMemoryEntity
SessionMemoryEntity.AddInteractionCmd - Record Class in akka.javasdk.agent
SessionMemoryEntity.CompactionCmd - Record Class in akka.javasdk.agent
SessionMemoryEntity.Event - Interface in akka.javasdk.agent: Sealed interface representing events that can occur in the SessionMemory entity.
SessionMemoryEntity.Event.AiMessageAdded - Record Class in akka.javasdk.agent
SessionMemoryEntity.Event.Deleted - Record Class in akka.javasdk.agent
SessionMemoryEntity.Event.HistoryCleared - Record Class in akka.javasdk.agent
SessionMemoryEntity.Event.LimitedWindowSet - Record Class in akka.javasdk.agent
SessionMemoryEntity.Event.ToolResponseMessageAdded - Record Class in akka.javasdk.agent
SessionMemoryEntity.Event.UserMessageAdded - Record Class in akka.javasdk.agent
SessionMemoryEntity.GetHistoryCmd - Record Class in akka.javasdk.agent
SessionMemoryEntity.LimitedWindow - Record Class in akka.javasdk.agent
SessionMemoryEntity.State - Record Class in akka.javasdk.agent
SessionMessage - Interface in akka.javasdk.agent: Interface for message representation used inside SessionMemoryEntity state.
SessionMessage.AiMessage - Record Class in akka.javasdk.agent
SessionMessage.ToolCallRequest - Record Class in akka.javasdk.agent
SessionMessage.ToolCallResponse - Record Class in akka.javasdk.agent
SessionMessage.UserMessage - Record Class in akka.javasdk.agent
set(String, String) - Method in interface akka.javasdk.Metadata: Set the string value for the given key.
setBinary(String, ByteBuffer) - Method in interface akka.javasdk.Metadata: Deprecated.
binary not supported, use Metadata.set(String, String)
setLimitedWindow(SessionMemoryEntity.LimitedWindow) - Method in class akka.javasdk.agent.SessionMemoryEntity
Setup - Annotation Interface in akka.javasdk.annotations: Mark a class as a central configuration point for an entire service.
single(Object) - Static method in interface akka.javasdk.DependencyProvider: Create a dependency provider that always returns the same instance for a given class.
size() - Method in record class akka.javasdk.agent.SessionMessage.AiMessage
size() - Method in interface akka.javasdk.agent.SessionMessage
size() - Method in record class akka.javasdk.agent.SessionMessage.ToolCallResponse
size() - Method in record class akka.javasdk.agent.SessionMessage.UserMessage
sizeInBytes() - Method in record class akka.javasdk.agent.SessionMemoryEntity.Event.AiMessageAdded: Returns the value of the sizeInBytes record component.
sizeInBytes() - Method in record class akka.javasdk.agent.SessionMemoryEntity.Event.ToolResponseMessageAdded: Returns the value of the sizeInBytes record component.
sizeInBytes() - Method in record class akka.javasdk.agent.SessionMemoryEntity.Event.UserMessageAdded: Returns the value of the sizeInBytes record component.
sizeInBytes(String) - Static method in interface akka.javasdk.agent.SessionMessage
Snapshots - Search tag in class akka.javasdk.eventsourcedentity.EventSourcedEntity: Section
source() - Method in interface akka.javasdk.client.ComponentStreamMethodRef
source() - Method in interface akka.javasdk.CloudEvent: The source of this CloudEvent.
source(A1) - Method in interface akka.javasdk.client.ComponentStreamMethodRef1
specversion() - Method in interface akka.javasdk.CloudEvent: The CloudEvent spec version.
startSingleTimer(String, Duration, int, DeferredCall<I, O>) - Method in interface akka.javasdk.timer.TimerScheduler: Deprecated, for removal: This API element is subject to removal in a future version.
Use TimerScheduler.createSingleTimerAsync(String, Duration, int, DeferredCall) instead.
startSingleTimer(String, Duration, DeferredCall<I, O>) - Method in interface akka.javasdk.timer.TimerScheduler: Deprecated, for removal: This API element is subject to removal in a future version.
Use TimerScheduler.createSingleTimerAsync(String, Duration, DeferredCall) instead.
startSpan(String) - Method in interface akka.javasdk.Tracing: If tracing is enabled, create and start a new custom span with the given name, setting a parent for the span is done automatically so that the span is a child of the incoming request or component call.
State(String, long, long, List<SessionMessage>) - Constructor for record class akka.javasdk.agent.SessionMemoryEntity.State: Creates an instance of a State record class.
staticClaims() - Element in annotation interface akka.javasdk.annotations.JWT: If set, the static claims provided and their values will be required when calling the service.
staticResource(HttpRequest, String) - Static method in class akka.javasdk.http.HttpResponses: Load a resource from the class-path directory static-resources and return it as an HTTP response.
staticResource(String) - Static method in class akka.javasdk.http.HttpResponses: Load a resource from the class-path directory static-resources and return it as an HTTP response.
status() - Method in record class akka.javasdk.http.StrictResponse
step(String) - Method in class akka.javasdk.workflow.StepBuilder
step(String) - Method in class akka.javasdk.workflow.Workflow: Start a step definition with a given step name.
StepBuilder - Class in akka.javasdk.workflow
StepBuilder(String) - Constructor for class akka.javasdk.workflow.StepBuilder: Not for direct user construction, instances are created through the workflow DSL
StepBuilder.AsyncCallStepBuilder<CallInput,CallOutput> - Class in akka.javasdk.workflow
StepBuilder.CallStepBuilder<CallInput,CallOutput> - Class in akka.javasdk.workflow
StepBuilder.RunnableStepBuilder - Class in akka.javasdk.workflow
StepConfig(String, Optional<Duration>, Optional<Workflow.RecoverStrategy<?>>) - Constructor for class akka.javasdk.workflow.Workflow.StepConfig
stepName - Variable in class akka.javasdk.workflow.Workflow.StepConfig
stream(Function<T, View.QueryStreamEffect<R>>) - Method in interface akka.javasdk.client.ViewClient: Pass in a View query method reference, e.g.
stream(Function2<T, A1, View.QueryStreamEffect<R>>) - Method in interface akka.javasdk.client.ViewClient: Pass in a View query method reference, e.g.
streamEffects() - Method in class akka.javasdk.agent.Agent
streamUpdates() - Element in annotation interface akka.javasdk.annotations.Query: For a query that returns a View.QueryStreamEffect, instead of completing the stream once the end of the result is reached, keep tailing the query and emit updates to the stream as the view is updated.
StrictResponse<T> - Record Class in akka.javasdk.http: A strict response that contains both the HTTP response and the body.
StrictResponse(HttpResponse, T) - Constructor for record class akka.javasdk.http.StrictResponse: Creates an instance of a StrictResponse record class.
subject() - Method in interface akka.javasdk.CloudEvent: The subject of this CloudEvent.
subject() - Method in interface akka.javasdk.JwtClaims: Get the subject, that is, the sub claim, as described in RFC 7519 section 4.1.2.
supportedClassNames() - Method in class akka.javasdk.JsonMigration: Override this method if you have changed the class name.
supportedForwardVersion() - Method in class akka.javasdk.JsonMigration: Define the supported forward version this migration can read (must be greater or equal than currentVersion).
systemMessage(String) - Method in interface akka.javasdk.agent.Agent.Effect.Builder: Provides system-level instructions to the AI model that defines its behavior and context.
systemMessage(String) - Method in interface akka.javasdk.agent.Agent.StreamEffect.Builder: Provides system-level instructions to the AI model that defines its behavior and context.
systemMessageFromTemplate(String) - Method in interface akka.javasdk.agent.Agent.Effect.Builder: Create a system message from a template.
systemMessageFromTemplate(String) - Method in interface akka.javasdk.agent.Agent.StreamEffect.Builder: Create a system message from a template.
systemMessageFromTemplate(String, Object...) - Method in interface akka.javasdk.agent.Agent.Effect.Builder: Create a system message from a template.
systemMessageFromTemplate(String, Object...) - Method in interface akka.javasdk.agent.Agent.StreamEffect.Builder: Create a system message from a template.

T

Table - Annotation Interface in akka.javasdk.annotations: Annotation for providing a table name for View components.
TableUpdater<S> - Class in akka.javasdk.view: Responsible for consuming events from a source and emit updates to one view table.
TableUpdater() - Constructor for class akka.javasdk.view.TableUpdater
TableUpdater.Effect<S> - Interface in akka.javasdk.view: An UpdateEffect is a description of what the runtime needs to do after the command is handled.
TableUpdater.Effect.Builder<S> - Interface in akka.javasdk.view
temperature() - Method in record class akka.javasdk.agent.ModelProvider.Anthropic: Returns the value of the temperature record component.
temperature() - Method in record class akka.javasdk.agent.ModelProvider.GoogleAIGemini: Returns the value of the temperature record component.
temperature() - Method in record class akka.javasdk.agent.ModelProvider.HuggingFace: Returns the value of the temperature record component.
temperature() - Method in record class akka.javasdk.agent.ModelProvider.LocalAI: Returns the value of the temperature record component.
temperature() - Method in record class akka.javasdk.agent.ModelProvider.Ollama: Returns the value of the temperature record component.
temperature() - Method in record class akka.javasdk.agent.ModelProvider.OpenAi: Returns the value of the temperature record component.
text() - Method in record class akka.javasdk.agent.SessionMessage.AiMessage: Returns the value of the text record component.
text() - Method in interface akka.javasdk.agent.SessionMessage
text() - Method in record class akka.javasdk.agent.SessionMessage.ToolCallResponse: Returns the value of the text record component.
text() - Method in record class akka.javasdk.agent.SessionMessage.UserMessage: Returns the value of the text record component.
thenReply() - Method in interface akka.javasdk.agent.Agent.Effect.FailureBuilder: Reply with the response from the model.
thenReply() - Method in interface akka.javasdk.agent.Agent.Effect.MappingFailureBuilder: Reply with the response from the model.
thenReply() - Method in interface akka.javasdk.agent.Agent.Effect.MappingResponseBuilder: Reply with the response from the model.
thenReply() - Method in interface akka.javasdk.agent.Agent.Effect.OnSuccessBuilder: Reply with the response from the model.
thenReply() - Method in interface akka.javasdk.agent.Agent.StreamEffect.OnSuccessBuilder: Reply with the response from the model.
thenReply(Metadata) - Method in interface akka.javasdk.agent.Agent.Effect.FailureBuilder: Reply with the response from the model.
thenReply(Metadata) - Method in interface akka.javasdk.agent.Agent.Effect.MappingFailureBuilder: Reply with the response from the model.
thenReply(Metadata) - Method in interface akka.javasdk.agent.Agent.Effect.MappingResponseBuilder: Reply with the response from the model.
thenReply(Metadata) - Method in interface akka.javasdk.agent.Agent.Effect.OnSuccessBuilder: Reply with the response from the model.
thenReply(Metadata) - Method in interface akka.javasdk.agent.Agent.StreamEffect.OnSuccessBuilder: Reply with the response from the model.
thenReply(Function<S, T>) - Method in interface akka.javasdk.eventsourcedentity.EventSourcedEntity.Effect.OnSuccessBuilder: Reply after for example persist event.
thenReply(Function<S, T>, Metadata) - Method in interface akka.javasdk.eventsourcedentity.EventSourcedEntity.Effect.OnSuccessBuilder: Reply after for example persist event.
thenReply(R) - Method in interface akka.javasdk.workflow.Workflow.Effect.TransitionalEffect: Reply after for example updateState.
thenReply(R, Metadata) - Method in interface akka.javasdk.workflow.Workflow.Effect.TransitionalEffect: Reply after for example updateState.
thenReply(T) - Method in interface akka.javasdk.keyvalueentity.KeyValueEntity.Effect.OnSuccessBuilder: Sends a reply message to the caller after the state operation (update or delete) completes successfully.
thenReply(T, Metadata) - Method in interface akka.javasdk.keyvalueentity.KeyValueEntity.Effect.OnSuccessBuilder: Sends a reply message with additional metadata to the caller after the state operation completes successfully.
time() - Method in interface akka.javasdk.CloudEvent: The time of this CloudEvent.
TimedAction - Class in akka.javasdk.timedaction: TimedAction is stateless component that can be used together with a TimerScheduler to schedule an action.
TimedAction() - Constructor for class akka.javasdk.timedaction.TimedAction
TimedAction.Effect - Interface in akka.javasdk.timedaction: An Effect is a description of what the runtime needs to do after the command is handled.
TimedAction.Effect.Builder - Interface in akka.javasdk.timedaction: Construct the effect that is returned by the command handler.
TimedActionClient - Interface in akka.javasdk.client
timeout - Variable in class akka.javasdk.workflow.Workflow.StepConfig
timeout() - Method in class akka.javasdk.workflow.Workflow.AsyncCallStep
timeout() - Method in class akka.javasdk.workflow.Workflow.CallStep
timeout() - Method in class akka.javasdk.workflow.Workflow.RunnableStep
timeout() - Method in interface akka.javasdk.workflow.Workflow.Step
timeout(Duration) - Method in class akka.javasdk.workflow.Workflow.AsyncCallStep: Define a step timeout.
timeout(Duration) - Method in class akka.javasdk.workflow.Workflow.CallStep: Define a step timeout.
timeout(Duration) - Method in class akka.javasdk.workflow.Workflow.RunnableStep: Define a step timeout.
timeout(Duration) - Method in class akka.javasdk.workflow.Workflow.WorkflowDef: Define a timeout for the duration of the entire workflow.
timers() - Method in class akka.javasdk.consumer.Consumer: Returns a TimerScheduler that can be used to schedule further in time.
timers() - Method in class akka.javasdk.timedaction.TimedAction: Returns a TimerScheduler that can be used to schedule further in time.
timers() - Method in class akka.javasdk.workflow.Workflow: Returns a TimerScheduler that can be used to schedule further in time.
TimerScheduler - Interface in akka.javasdk.timer
timestamp() - Method in record class akka.javasdk.agent.SessionMemoryEntity.Event.AiMessageAdded: Returns the value of the timestamp record component.
timestamp() - Method in record class akka.javasdk.agent.SessionMemoryEntity.Event.Deleted: Returns the value of the timestamp record component.
timestamp() - Method in record class akka.javasdk.agent.SessionMemoryEntity.Event.LimitedWindowSet: Returns the value of the timestamp record component.
timestamp() - Method in record class akka.javasdk.agent.SessionMemoryEntity.Event.ToolResponseMessageAdded: Returns the value of the timestamp record component.
timestamp() - Method in record class akka.javasdk.agent.SessionMemoryEntity.Event.UserMessageAdded: Returns the value of the timestamp record component.
timestamp() - Method in record class akka.javasdk.agent.SessionMessage.AiMessage: Returns the value of the timestamp record component.
timestamp() - Method in record class akka.javasdk.agent.SessionMessage.ToolCallResponse: Returns the value of the timestamp record component.
timestamp() - Method in record class akka.javasdk.agent.SessionMessage.UserMessage: Returns the value of the timestamp record component.
tokenStream(Function<T, Agent.StreamEffect>) - Method in interface akka.javasdk.client.AgentClientInSession: Pass in an Agent command handler method reference, e.g.
tokenStream(Function2<T, A1, Agent.StreamEffect>) - Method in interface akka.javasdk.client.AgentClientInSession: Pass in an Agent command handler method reference, e.g.
toMap() - Method in interface akka.javasdk.http.QueryParams: Returns a key/value map of the parameters.
toMultiMap() - Method in interface akka.javasdk.http.QueryParams: Returns a `Map` of all parameters.
ToolAnnotation - Enum Class in akka.javasdk.annotations.mcp: Behavioral annotations that describe MCP tool characteristics to clients.
ToolCallExecutionException - Exception Class in akka.javasdk.agent: Exception thrown when there is a failure executing a tool call.
ToolCallExecutionException(String, String, Throwable) - Constructor for exception class akka.javasdk.agent.ToolCallExecutionException
ToolCallLimitReachedException - Exception Class in akka.javasdk.agent: Thrown when the maximum number of tool call steps has been reached.
ToolCallLimitReachedException(String) - Constructor for exception class akka.javasdk.agent.ToolCallLimitReachedException
ToolCallRequest(String, String, String) - Constructor for record class akka.javasdk.agent.SessionMessage.ToolCallRequest: Creates an instance of a ToolCallRequest record class.
toolCallRequests() - Method in record class akka.javasdk.agent.SessionMemoryEntity.Event.AiMessageAdded: Returns the value of the toolCallRequests record component.
toolCallRequests() - Method in record class akka.javasdk.agent.SessionMessage.AiMessage: Returns the value of the toolCallRequests record component.
ToolCallResponse(Instant, String, String, String, String) - Constructor for record class akka.javasdk.agent.SessionMessage.ToolCallResponse: Creates an instance of a ToolCallResponse record class.
toolName() - Method in interface akka.javasdk.agent.RemoteMcpTools.ToolInterceptorContext
ToolResponseMessageAdded(Instant, String, String, String, String, int) - Constructor for record class akka.javasdk.agent.SessionMemoryEntity.Event.ToolResponseMessageAdded: Creates an instance of a ToolResponseMessageAdded record class.
tools(Object, Object...) - Method in interface akka.javasdk.agent.Agent.Effect.Builder: Adds one or more tool instances or classes that the AI model can use.
tools(Object, Object...) - Method in interface akka.javasdk.agent.Agent.StreamEffect.Builder: Adds one or more tool instances or classes that the AI model can use.
tools(List<Object>) - Method in interface akka.javasdk.agent.Agent.Effect.Builder: Adds one or more tool instances or classes that the AI model can use.
tools(List<Object>) - Method in interface akka.javasdk.agent.Agent.StreamEffect.Builder: Adds one or more tool instances or classes that the AI model can use.
topK() - Method in record class akka.javasdk.agent.ModelProvider.Anthropic: Returns the value of the topK record component.
topP() - Method in record class akka.javasdk.agent.ModelProvider.Anthropic: Returns the value of the topP record component.
topP() - Method in record class akka.javasdk.agent.ModelProvider.GoogleAIGemini: Returns the value of the topP record component.
topP() - Method in record class akka.javasdk.agent.ModelProvider.HuggingFace: Returns the value of the topP record component.
topP() - Method in record class akka.javasdk.agent.ModelProvider.LocalAI: Returns the value of the topP record component.
topP() - Method in record class akka.javasdk.agent.ModelProvider.Ollama: Returns the value of the topP record component.
topP() - Method in record class akka.javasdk.agent.ModelProvider.OpenAi: Returns the value of the topP record component.
toString() - Method in record class akka.javasdk.agent.AgentRegistry.AgentInfo: Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.agent.MemoryProvider.CustomMemoryProvider: Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.agent.MemoryProvider.Disabled: Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.agent.MemoryProvider.FromConfig: Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.agent.MemoryProvider.LimitedWindowMemoryProvider: Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.agent.ModelProvider.Anthropic: Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.agent.ModelProvider.FromConfig: Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.agent.ModelProvider.GoogleAIGemini: Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.agent.ModelProvider.HuggingFace: Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.agent.ModelProvider.LocalAI: Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.agent.ModelProvider.Ollama: Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.agent.ModelProvider.OpenAi: Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.agent.PromptTemplate.Event.Deleted: Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.agent.PromptTemplate.Event.Updated: Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.agent.PromptTemplate.Prompt: Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.agent.SessionHistory: Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.agent.SessionMemoryEntity.AddInteractionCmd: Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.agent.SessionMemoryEntity.CompactionCmd: Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.agent.SessionMemoryEntity.Event.AiMessageAdded: Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.agent.SessionMemoryEntity.Event.Deleted: Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.agent.SessionMemoryEntity.Event.HistoryCleared: Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.agent.SessionMemoryEntity.Event.LimitedWindowSet: Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.agent.SessionMemoryEntity.Event.ToolResponseMessageAdded: Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.agent.SessionMemoryEntity.Event.UserMessageAdded: Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.agent.SessionMemoryEntity.GetHistoryCmd: Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.agent.SessionMemoryEntity.LimitedWindow: Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.agent.SessionMemoryEntity.State: Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.agent.SessionMessage.AiMessage: Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.agent.SessionMessage.ToolCallRequest: Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.agent.SessionMessage.ToolCallResponse: Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.agent.SessionMessage.UserMessage: Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.http.StrictResponse: Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.impl.agent.SessionMemoryClient.MemorySettings: Returns a string representation of this record class.
toString() - Method in class akka.javasdk.Principal.LocalService
tracing() - Method in interface akka.javasdk.agent.AgentContext: Provides access to tracing for custom application-specific tracing.
tracing() - Method in interface akka.javasdk.consumer.MessageContext: Access to tracing for custom app specific tracing.
tracing() - Method in interface akka.javasdk.eventsourcedentity.CommandContext: Provides access to tracing functionality for adding custom application-specific tracing information to the current command processing.
tracing() - Method in interface akka.javasdk.grpc.GrpcRequestContext: Access to tracing for custom app specific tracing.
tracing() - Method in interface akka.javasdk.http.RequestContext: Access to tracing for custom app specific tracing.
tracing() - Method in interface akka.javasdk.keyvalueentity.CommandContext: Provides access to tracing functionality for adding custom application-specific tracing information to the current command processing.
tracing() - Method in interface akka.javasdk.mcp.McpRequestContext: Access to tracing for custom app specific tracing.
tracing() - Method in interface akka.javasdk.timedaction.CommandContext: Access to tracing for custom app specific tracing.
tracing() - Method in interface akka.javasdk.workflow.CommandContext: Access to tracing for custom app specific tracing.
tracing() - Method in interface akka.javasdk.workflow.WorkflowContext: Access to tracing for custom app specific tracing.
Tracing - Interface in akka.javasdk: Factory for manually creating open telemetry spans in addition to those automatically provided by the runtime and SDK.
transform(int, JsonNode) - Method in class akka.javasdk.JsonMigration: Implement the transformation of the incoming JSON structure to the current JSON structure.
transitionFunc - Variable in class akka.javasdk.workflow.Workflow.AsyncCallStep
transitionFunc - Variable in class akka.javasdk.workflow.Workflow.CallStep
transitionFunc - Variable in class akka.javasdk.workflow.Workflow.RunnableStep
transitionInputClass - Variable in class akka.javasdk.workflow.Workflow.AsyncCallStep
transitionInputClass - Variable in class akka.javasdk.workflow.Workflow.CallStep
transitionTo(String) - Method in interface akka.javasdk.workflow.Workflow.Effect.Builder: Defines the next step to which the workflow should transition to.
transitionTo(String) - Method in interface akka.javasdk.workflow.Workflow.Effect.PersistenceEffectBuilder: Defines the next step to which the workflow should transition to.
transitionTo(String, I) - Method in interface akka.javasdk.workflow.Workflow.Effect.Builder: Defines the next step to which the workflow should transition to.
transitionTo(String, I) - Method in interface akka.javasdk.workflow.Workflow.Effect.PersistenceEffectBuilder: Defines the next step to which the workflow should transition to.
type() - Method in interface akka.javasdk.CloudEvent: The type of this CloudEvent.
TypeName - Annotation Interface in akka.javasdk.annotations: Annotation to assign a logical type name to events.

U

unauthorized() - Static method in class akka.javasdk.http.HttpException
unauthorized(String) - Static method in class akka.javasdk.http.HttpException
UNSPECIFIED - Enum constant in enum class akka.javasdk.annotations.Acl.Principal
UNSPECIFIED - Enum constant in enum class akka.javasdk.annotations.JWT.JwtMethodMode: No validation.
UnsupportedFeatureException - Exception Class in akka.javasdk.agent: Exception thrown when an unsupported feature is requested from an AI model or service.
UnsupportedFeatureException(String) - Constructor for exception class akka.javasdk.agent.UnsupportedFeatureException
update(String) - Method in class akka.javasdk.agent.PromptTemplate: Update the prompt template.
updateContext() - Method in class akka.javasdk.view.TableUpdater: Additional context and metadata for an update handler.
UpdateContext - Interface in akka.javasdk.view: Context for view update calls.
Updated(String) - Constructor for record class akka.javasdk.agent.PromptTemplate.Event.Updated: Creates an instance of a Updated record class.
updateRow(S) - Method in interface akka.javasdk.view.TableUpdater.Effect.Builder
updateState(S) - Method in interface akka.javasdk.keyvalueentity.KeyValueEntity.Effect.Builder: Updates the entity state with the provided new state.
updateState(S) - Method in interface akka.javasdk.workflow.Workflow.Effect.Builder
uri() - Element in annotation interface akka.javasdk.annotations.mcp.McpResource
uriTemplate() - Element in annotation interface akka.javasdk.annotations.mcp.McpResource
userMessage() - Method in record class akka.javasdk.agent.SessionMemoryEntity.AddInteractionCmd: Returns the value of the userMessage record component.
userMessage() - Method in record class akka.javasdk.agent.SessionMemoryEntity.CompactionCmd: Returns the value of the userMessage record component.
userMessage(String) - Method in interface akka.javasdk.agent.Agent.Effect.Builder: The user message to the AI model.
userMessage(String) - Method in interface akka.javasdk.agent.Agent.StreamEffect.Builder
UserMessage(Instant, String, String) - Constructor for record class akka.javasdk.agent.SessionMessage.UserMessage: Creates an instance of a UserMessage record class.
UserMessageAdded(Instant, String, String, int) - Constructor for record class akka.javasdk.agent.SessionMemoryEntity.Event.UserMessageAdded: Creates an instance of a UserMessageAdded record class.

V

validate() - Element in annotation interface akka.javasdk.annotations.JWT
value() - Method in record class akka.javasdk.agent.PromptTemplate.Prompt: Returns the value of the value record component.
value() - Element in annotation interface akka.javasdk.annotations.ComponentId
value() - Element in annotation interface akka.javasdk.annotations.Consume.FromEventSourcedEntity: Assign the class type of the entity one intends to consume from, which must extend EventSourcedEntity.
value() - Element in annotation interface akka.javasdk.annotations.Consume.FromKeyValueEntity: Assign the class type of the entity one intends to consume from, which must extend KeyValueEntity.
value() - Element in annotation interface akka.javasdk.annotations.Consume.FromTopic: Assign the name of the topic to consume the stream from.
value() - Element in annotation interface akka.javasdk.annotations.Consume.FromWorkflow: Assign the class type of the workflow one intends to consume from, which must extend Workflow.
value() - Element in annotation interface akka.javasdk.annotations.Description
value() - Element in annotation interface akka.javasdk.annotations.http.Delete
value() - Element in annotation interface akka.javasdk.annotations.http.Get
value() - Element in annotation interface akka.javasdk.annotations.http.HttpEndpoint
value() - Element in annotation interface akka.javasdk.annotations.http.Patch
value() - Element in annotation interface akka.javasdk.annotations.http.Post
value() - Element in annotation interface akka.javasdk.annotations.http.Put
value() - Element in annotation interface akka.javasdk.annotations.Migration
value() - Element in annotation interface akka.javasdk.annotations.Produce.ToTopic: Assign the name of the topic to be used for eventing out.
value() - Element in annotation interface akka.javasdk.annotations.Query: Assigns the actual query which makes use of the enclosing entity table name as source of data for composition.
value() - Element in annotation interface akka.javasdk.annotations.Table: Assign a table name.
value() - Element in annotation interface akka.javasdk.annotations.TypeName: Logical type name for the annotated type.
valueOf(String) - Static method in enum class akka.javasdk.annotations.Acl.Principal: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class akka.javasdk.annotations.JWT.JwtMethodMode: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class akka.javasdk.annotations.mcp.ToolAnnotation: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class akka.javasdk.Principal.Basic: Returns the enum constant of this class with the specified name.
values() - Static method in enum class akka.javasdk.annotations.Acl.Principal: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class akka.javasdk.annotations.JWT.JwtMethodMode: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Element in annotation interface akka.javasdk.annotations.JWT.StaticClaim: The value can be set as: a hardcoded literal (e.g.
values() - Static method in enum class akka.javasdk.annotations.mcp.ToolAnnotation: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class akka.javasdk.Principal.Basic: Returns an array containing the constants of this enum class, in the order they are declared.
View - Class in akka.javasdk.view: A service that follows the Command Query Responsibility Segregation (CQRS) pattern.
View() - Constructor for class akka.javasdk.view.View
View.QueryEffect<T> - Interface in akka.javasdk.view: Not for user extension, instances are returned through factory method {View.queryResult()}
View.QueryStreamEffect<T> - Interface in akka.javasdk.view: Not for user extension, instances are returned through factory method View.queryStreamResult()
ViewClient - Interface in akka.javasdk.client: Not for user extension

W

withAccessToken(String) - Method in record class akka.javasdk.agent.ModelProvider.HuggingFace
withAllowedToolNames(String, String...) - Method in interface akka.javasdk.agent.RemoteMcpTools: Define a set of allowed tool names.
withAllowedToolNames(Set<String>) - Method in interface akka.javasdk.agent.RemoteMcpTools: Define a set of allowed tool names.
withApiKey(String) - Method in record class akka.javasdk.agent.ModelProvider.Anthropic
withApiKey(String) - Method in record class akka.javasdk.agent.ModelProvider.GoogleAIGemini
withApiKey(String) - Method in record class akka.javasdk.agent.ModelProvider.OpenAi
withBaseUrl(String) - Method in record class akka.javasdk.agent.ModelProvider.Anthropic
withBaseUrl(String) - Method in record class akka.javasdk.agent.ModelProvider.HuggingFace
withBaseUrl(String) - Method in record class akka.javasdk.agent.ModelProvider.Ollama
withBaseUrl(String) - Method in record class akka.javasdk.agent.ModelProvider.OpenAi
withDatacontenttype(String) - Method in interface akka.javasdk.CloudEvent: Return a new CloudEvent with the given data content type.
withDataschema(URI) - Method in interface akka.javasdk.CloudEvent: Return a new CloudEvent with the given data schema.
withHeaders(Iterable<HttpHeader>) - Method in interface akka.javasdk.http.RequestBuilder
withId(String) - Method in interface akka.javasdk.CloudEvent: Return a new CloudEvent with the given id.
withMaxNewTokens(Integer) - Method in record class akka.javasdk.agent.ModelProvider.HuggingFace
withMaxOutputTokens(int) - Method in record class akka.javasdk.agent.ModelProvider.GoogleAIGemini
withMaxSize(int) - Method in record class akka.javasdk.agent.SessionMemoryEntity.State
withMaxTokens(int) - Method in record class akka.javasdk.agent.ModelProvider.Anthropic
withMaxTokens(int) - Method in record class akka.javasdk.agent.ModelProvider.LocalAI
withMaxTokens(int) - Method in record class akka.javasdk.agent.ModelProvider.OpenAi
withMetadata(Metadata) - Method in interface akka.javasdk.client.ComponentDeferredMethodRef
withMetadata(Metadata) - Method in interface akka.javasdk.client.ComponentDeferredMethodRef1
withMetadata(Metadata) - Method in interface akka.javasdk.client.ComponentInvokeOnlyMethodRef
withMetadata(Metadata) - Method in interface akka.javasdk.client.ComponentInvokeOnlyMethodRef1
withMetadata(Metadata) - Method in interface akka.javasdk.client.ComponentMethodRef
withMetadata(Metadata) - Method in interface akka.javasdk.client.ComponentMethodRef1
withMetadata(Metadata) - Method in interface akka.javasdk.client.DynamicMethodRef
withMetadata(Metadata) - Method in interface akka.javasdk.DeferredCall
withModelId(String) - Method in record class akka.javasdk.agent.ModelProvider.HuggingFace
withModelName(String) - Method in record class akka.javasdk.agent.ModelProvider.Anthropic
withModelName(String) - Method in record class akka.javasdk.agent.ModelProvider.GoogleAIGemini
withModelName(String) - Method in record class akka.javasdk.agent.ModelProvider.LocalAI
withModelName(String) - Method in record class akka.javasdk.agent.ModelProvider.Ollama
withModelName(String) - Method in record class akka.javasdk.agent.ModelProvider.OpenAi
withRequest(HttpRequest) - Method in interface akka.javasdk.http.RequestBuilder
withRequestBody(byte[]) - Method in interface akka.javasdk.http.RequestBuilder: Prepare for sending an HTTP request with an application/octet-stream body.
withRequestBody(ContentType, byte[]) - Method in interface akka.javasdk.http.RequestBuilder: Prepare for sending an HTTP request with an arbitrary payload encoded as described by the content type
withRequestBody(Object) - Method in interface akka.javasdk.http.RequestBuilder: Prepare for sending an HTTP request with an application/json body.
withRequestBody(String) - Method in interface akka.javasdk.http.RequestBuilder: Prepare for sending an HTTP request with a text/plain body.
withRetry(int) - Method in interface akka.javasdk.client.ComponentMethodRef: Set the retry settings for this call.
withRetry(int) - Method in interface akka.javasdk.client.ComponentMethodRef1: Set the retry settings for this call.
withRetry(int) - Method in interface akka.javasdk.client.DynamicMethodRef: Set the retry settings for this call.
withRetry(int) - Method in interface akka.javasdk.http.RequestBuilder: Set the retry settings for this call.
withRetry(RetrySettings) - Method in interface akka.javasdk.client.ComponentMethodRef: Set the retry settings for this call.
withRetry(RetrySettings) - Method in interface akka.javasdk.client.ComponentMethodRef1: Set the retry settings for this call.
withRetry(RetrySettings) - Method in interface akka.javasdk.client.DynamicMethodRef: Set the retry settings for this call.
withRetry(RetrySettings) - Method in interface akka.javasdk.http.RequestBuilder: Set the retry settings for this call.
withSequence(String) - Method in interface akka.javasdk.CloudEvent: Return a new CloudEvent with the given sequence.
withSequenceType(String) - Method in interface akka.javasdk.CloudEvent: Return a new CloudEvent with the given sequence type.
withSource(URI) - Method in interface akka.javasdk.CloudEvent: Return a new CloudEvent with the given source.
withSubject(String) - Method in interface akka.javasdk.CloudEvent: Return a new CloudEvent with the given subject.
withTemperature(double) - Method in record class akka.javasdk.agent.ModelProvider.Anthropic
withTemperature(double) - Method in record class akka.javasdk.agent.ModelProvider.GoogleAIGemini
withTemperature(double) - Method in record class akka.javasdk.agent.ModelProvider.LocalAI
withTemperature(double) - Method in record class akka.javasdk.agent.ModelProvider.Ollama
withTemperature(double) - Method in record class akka.javasdk.agent.ModelProvider.OpenAi
withTemperature(Double) - Method in record class akka.javasdk.agent.ModelProvider.HuggingFace
withTime(ZonedDateTime) - Method in interface akka.javasdk.CloudEvent: Return a new CloudEvent with the given time.
withTimeout(Duration) - Method in interface akka.javasdk.http.RequestBuilder
withToolInterceptor(RemoteMcpTools.ToolInterceptor) - Method in interface akka.javasdk.agent.RemoteMcpTools: Specify an interceptor that has the capability to allow or deny calls (by throwing an exception) and also to modify and filter input to the MCP server tool.
withToolNameFilter(Predicate<String>) - Method in interface akka.javasdk.agent.RemoteMcpTools: Define a filter to select what discovered tool names are passed on to the chat model.
withTopK(int) - Method in record class akka.javasdk.agent.ModelProvider.Anthropic
withTopP(double) - Method in record class akka.javasdk.agent.ModelProvider.Anthropic
withTopP(double) - Method in record class akka.javasdk.agent.ModelProvider.GoogleAIGemini
withTopP(double) - Method in record class akka.javasdk.agent.ModelProvider.LocalAI
withTopP(double) - Method in record class akka.javasdk.agent.ModelProvider.Ollama
withTopP(double) - Method in record class akka.javasdk.agent.ModelProvider.OpenAi
withTopP(Double) - Method in record class akka.javasdk.agent.ModelProvider.HuggingFace
withType(String) - Method in interface akka.javasdk.CloudEvent: Return a new CloudEvent with the given type.
workflow() - Method in class akka.javasdk.workflow.Workflow
Workflow<S> - Class in akka.javasdk.workflow: Workflows are stateful components and are defined by a set of steps and transitions between them.
Workflow() - Constructor for class akka.javasdk.workflow.Workflow
Workflow.AsyncCallStep<CallInput,CallOutput,FailoverInput> - Class in akka.javasdk.workflow
Workflow.CallStep<CallInput,CallOutput,FailoverInput> - Class in akka.javasdk.workflow
Workflow.Effect<T> - Interface in akka.javasdk.workflow: An Effect is a description of what the runtime needs to do after the command is handled.
Workflow.Effect.Builder<S> - Interface in akka.javasdk.workflow: Construct the effect that is returned by the command handler or a step transition.
Workflow.Effect.PersistenceEffectBuilder<T> - Interface in akka.javasdk.workflow
Workflow.Effect.TransitionalEffect<T> - Interface in akka.javasdk.workflow: A workflow effect type that contains information about the transition to the next step.
Workflow.ReadOnlyEffect<T> - Interface in akka.javasdk.workflow: An effect that is known to be read only and does not update the state of the entity.
Workflow.RecoverStrategy<T> - Class in akka.javasdk.workflow
Workflow.RecoverStrategy.MaxRetries - Class in akka.javasdk.workflow: Retry strategy without failover configuration
Workflow.RunnableStep - Class in akka.javasdk.workflow
Workflow.Step - Interface in akka.javasdk.workflow
Workflow.StepConfig - Class in akka.javasdk.workflow
Workflow.WorkflowDef<S> - Class in akka.javasdk.workflow
WorkflowClient - Interface in akka.javasdk.client: Not for user extension
WorkflowContext - Interface in akka.javasdk.workflow
workflowId() - Method in interface akka.javasdk.workflow.CommandContext: The id of the workflow that this context is for.
workflowId() - Method in interface akka.javasdk.workflow.WorkflowContext: The id of the workflow that this context is for.
write() - Method in record class akka.javasdk.agent.MemoryProvider.LimitedWindowMemoryProvider: Returns the value of the write record component.
write() - Method in record class akka.javasdk.impl.agent.SessionMemoryClient.MemorySettings: Returns the value of the write record component.
writeOnly() - Method in record class akka.javasdk.agent.MemoryProvider.LimitedWindowMemoryProvider: Creates a write-only version of this memory provider.

A B C D E F G H I J K L M N O P Q R S T U V W
All Classes and Interfaces|All Packages|Serialized Form