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|Constant Field Values|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.
Accepted() - Constructor for record class akka.javasdk.agent.task.TaskRule.Result.Accepted
Creates an instance of a Accepted record class.
accessToken() - Method in record class akka.javasdk.agent.ModelProvider.Bedrock
Returns the value of the accessToken record component.
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.
Activated() - Constructor for record class akka.javasdk.agent.autonomous.Notification.Activated
Creates an instance of a Activated record class.
add(SessionMessage.TokenUsage) - Method in record class akka.javasdk.agent.SessionMessage.TokenUsage
 
add(String, String) - Method in interface akka.javasdk.Metadata
Add the string value for the given key.
addClientHeader(HttpHeader) - Method in interface akka.javasdk.agent.RemoteMcpTools
 
addCredentials(HttpCredentials) - Method in interface akka.javasdk.http.RequestBuilder
 
addHandoffTargets(Class<? extends AutonomousAgent>, Class<? extends AutonomousAgent>[]) - Method in class akka.javasdk.agent.autonomous.capability.TaskAcceptance
Internal method for adding handoff targets — implemented by the impl class.
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.MultimodalUserMessage, 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, supporting multimodal content.
addInteraction(String, SessionMessage.MultimodalUserMessage, List<SessionMessage>) - Method in class akka.javasdk.impl.agent.SessionMemoryClient
 
addInteraction(String, SessionMessage.UserMessage, List<SessionMessage>) - Method in interface akka.javasdk.agent.SessionMemory
Adds an interaction 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.
additionalModelRequestFields() - Method in record class akka.javasdk.agent.ModelProvider.Bedrock
Returns the value of the additionalModelRequestFields record component.
additionalModelRequestHeaders() - Method in record class akka.javasdk.agent.ModelProvider.Anthropic
Returns the value of the additionalModelRequestHeaders record component.
additionalModelRequestHeaders() - Method in record class akka.javasdk.agent.ModelProvider.AzureOpenAi
Returns the value of the additionalModelRequestHeaders record component.
additionalModelRequestHeaders() - Method in record class akka.javasdk.agent.ModelProvider.Bedrock
Returns the value of the additionalModelRequestHeaders record component.
additionalModelRequestHeaders() - Method in record class akka.javasdk.agent.ModelProvider.GoogleAIGemini
Returns the value of the additionalModelRequestHeaders record component.
additionalModelRequestHeaders() - Method in record class akka.javasdk.agent.ModelProvider.HuggingFace
Returns the value of the additionalModelRequestHeaders record component.
additionalModelRequestHeaders() - Method in record class akka.javasdk.agent.ModelProvider.LocalAI
Returns the value of the additionalModelRequestHeaders record component.
additionalModelRequestHeaders() - Method in record class akka.javasdk.agent.ModelProvider.MistralAi
Returns the value of the additionalModelRequestHeaders record component.
additionalModelRequestHeaders() - Method in record class akka.javasdk.agent.ModelProvider.Ollama
Returns the value of the additionalModelRequestHeaders record component.
additionalModelRequestHeaders() - Method in record class akka.javasdk.agent.ModelProvider.OpenAi
Returns the value of the additionalModelRequestHeaders record component.
additionalModelRequestHeaders() - Method in record class akka.javasdk.agent.ModelProvider.VertexAi
Returns the value of the additionalModelRequestHeaders record component.
addMessage(SessionMessage) - Method in record class akka.javasdk.agent.SessionMemoryEntity.State
 
addMultimodalInteraction(SessionMemoryEntity.AddMultimodalInteractionCmd) - Method in class akka.javasdk.agent.SessionMemoryEntity
 
AddMultimodalInteractionCmd(SessionMessage.MultimodalUserMessage, List<SessionMessage>) - Constructor for record class akka.javasdk.agent.SessionMemoryEntity.AddMultimodalInteractionCmd
Creates an instance of a AddMultimodalInteractionCmd record class.
addQueryParameter(String, String) - Method in interface akka.javasdk.http.RequestBuilder
 
addTask(String) - Method in class akka.javasdk.impl.agent.task.BacklogEntity
Add a task reference to this backlog.
AFTER_SYSTEM - Enum constant in enum class akka.javasdk.agent.ModelProvider.BedrockPromptCachePlacement
 
AFTER_TOOLS - Enum constant in enum class akka.javasdk.agent.ModelProvider.BedrockPromptCachePlacement
 
AFTER_USER_MESSAGE - Enum constant in enum class akka.javasdk.agent.ModelProvider.BedrockPromptCachePlacement
 
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.AgentReply<T> - Record Class in akka.javasdk.agent
A detailed reply from an agent component call, containing both the result and additional information, like token usage.
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
 
Agent.TokenUsage - Record Class in akka.javasdk.agent
 
AgentCapability - Interface in akka.javasdk.agent.autonomous.capability
A capability that an autonomous agent can have.
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.
AgentDefinition - Interface in akka.javasdk.agent.autonomous
Defines an autonomous agent's configuration: tools, model provider, guardrails, capabilities, and optional instructions.
AgentDelegationWorker - Interface in akka.javasdk.agent
Marker interface implemented by agent types that can act as delegation workers.
agentId(String) - Static method in record class akka.javasdk.agent.MemoryFilter.Exclude
 
agentId(String) - Static method in record class akka.javasdk.agent.MemoryFilter.Include
 
agentIds(Set<String>) - Static method in record class akka.javasdk.agent.MemoryFilter.Exclude
 
agentIds(Set<String>) - Static method in record class akka.javasdk.agent.MemoryFilter.Include
 
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.
agentInfoOption(String) - Method in interface akka.javasdk.agent.AgentRegistry
Information about a given agent.
AgentInvokeOnlyMethodRef<R> - Interface in akka.javasdk.client
Zero argument agent component call representation, returning a detailed reply including token usage, not executed until invoked.
AgentInvokeOnlyMethodRef1<A1,R> - Interface in akka.javasdk.client
One argument agent component call representation, returning a detailed reply including token usage, not executed until invoked.
AgentMethodRef<R> - Interface in akka.javasdk.client
Zero argument agent component call representation.
AgentMethodRef1<A1,R> - Interface in akka.javasdk.client
One argument agent component call representation.
agentRegistry - Variable in class akka.javasdk.agent.SessionMemoryEntity
 
AgentRegistry - Interface in akka.javasdk.agent
The registry contains information about all agents.
AgentRegistry.AgentInfo - Record Class in akka.javasdk.agent
 
AgentReply(T, Agent.TokenUsage) - Constructor for record class akka.javasdk.agent.Agent.AgentReply
Creates an instance of a AgentReply record class.
AgentReplyInvokeOnlyMethodRef<R> - Interface in akka.javasdk.client
Zero argument agent component call representation, returning a detailed reply including token usage, not executed until invoked.
AgentReplyInvokeOnlyMethodRef1<A1,R> - Interface in akka.javasdk.client
One argument agent component call representation, returning a detailed reply including token usage, not executed until invoked.
agentRole(String) - Static method in record class akka.javasdk.agent.MemoryFilter.Exclude
 
agentRole(String) - Static method in record class akka.javasdk.agent.MemoryFilter.Include
 
AgentRole - Annotation Interface in akka.javasdk.annotations
Defines the role of an agent.
agentRoles(Set<String>) - Static method in record class akka.javasdk.agent.MemoryFilter.Exclude
 
agentRoles(Set<String>) - Static method in record class akka.javasdk.agent.MemoryFilter.Include
 
AgentSetup - Interface in akka.javasdk.agent.autonomous
Per-instance configuration applied on top of an agent's static AgentDefinition.
AgentState - Class in akka.javasdk.agent.autonomous
Summary of an autonomous agent's current state.
AgentState(String, boolean, String, AutonomousAgent.TokenUsage, Optional<TaskKey>, List<String>) - Constructor for class akka.javasdk.agent.autonomous.AgentState
 
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, SessionMessage.TokenUsage) - 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
 
AiMessage(Instant, String, String, List<SessionMessage.ToolCallRequest>, Optional<String>) - Constructor for record class akka.javasdk.agent.SessionMessage.AiMessage
 
AiMessage(Instant, String, String, List<SessionMessage.ToolCallRequest>, Optional<String>, SessionMessage.TokenUsage, Map<String, Object>) - 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>, Optional<String>, Optional<SessionMessage.TokenUsage>, Map<String, Object>) - 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.agent.autonomous - package akka.javasdk.agent.autonomous
 
akka.javasdk.agent.autonomous.capability - package akka.javasdk.agent.autonomous.capability
 
akka.javasdk.agent.evaluator - package akka.javasdk.agent.evaluator
 
akka.javasdk.agent.task - package akka.javasdk.agent.task
 
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.impl.agent.task - package akka.javasdk.impl.agent.task
 
akka.javasdk.keyvalueentity - package akka.javasdk.keyvalueentity
Key Value Entity components for building stateful services that persist complete state on every change.
akka.javasdk.mcp - package akka.javasdk.mcp
 
akka.javasdk.objectstorage - package akka.javasdk.objectstorage
 
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
 
annotations() - Element in annotation interface akka.javasdk.annotations.mcp.McpTool
Optional annotations describing what the tool does to the client.
answer() - Method in record class akka.javasdk.agent.evaluator.HallucinationEvaluator.EvaluationRequest
Returns the value of the answer record component.
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, Duration, Duration, int, int, List<HttpHeader>) - Constructor for record class akka.javasdk.agent.ModelProvider.Anthropic
Deprecated.
Use constructor with prompt caching settings
Anthropic(String, String, String, double, double, int, int, Duration, Duration, int, int, List<HttpHeader>, boolean, boolean) - 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.AzureOpenAi
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.MistralAi
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.
apiKey() - Method in record class akka.javasdk.agent.ModelProvider.VertexAi
Returns the value of the apiKey record component.
apiVersion() - Method in record class akka.javasdk.agent.ModelProvider.VertexAi
Returns the value of the apiVersion record component.
apply(SessionMemoryEntity.Event.AiMessageAdded) - Static method in class akka.javasdk.agent.SessionMessageConverter
 
apply(SessionMemoryEntity.Event.Message) - Static method in class akka.javasdk.agent.SessionMessageConverter
 
apply(SessionMemoryEntity.Event.MultimodalUserMessageAdded) - Static method in class akka.javasdk.agent.SessionMessageConverter
 
apply(SessionMemoryEntity.Event.ToolResponseMessageAdded) - Static method in class akka.javasdk.agent.SessionMessageConverter
 
apply(SessionMemoryEntity.Event.UserMessageAdded) - Static method in class akka.javasdk.agent.SessionMessageConverter
 
applyEvent(PromptTemplate.Event) - Method in class akka.javasdk.agent.PromptTemplate
 
applyEvent(SessionMemoryEntity.Event) - Method in class akka.javasdk.agent.SessionMemoryEntity
 
applyEvent(TaskEvent) - Method in class akka.javasdk.agent.task.TaskEntity
 
applyEvent(BacklogEvent) - Method in class akka.javasdk.impl.agent.task.BacklogEntity
 
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.
assign(String) - Method in class akka.javasdk.agent.task.TaskEntity
 
assign(String) - Method in interface akka.javasdk.client.TaskClient
Assign a task to an owner.
assignAsync(String) - Method in interface akka.javasdk.client.TaskClient
ASSIGNED - Enum constant in enum class akka.javasdk.agent.task.TaskStatus
Assigned to an agent but not yet started.
assignee() - Method in record class akka.javasdk.agent.task.TaskEvent.TaskAssigned
Returns the value of the assignee record component.
assignee() - Method in record class akka.javasdk.agent.task.TaskState
Returns the value of the assignee record component.
assignTasks(String...) - Method in interface akka.javasdk.client.AutonomousAgentClient
Assign one or more previously created tasks to this agent.
assignTasksAsync(String...) - Method in interface akka.javasdk.client.AutonomousAgentClient
asyncDone(CompletionStage<Done>) - Method in interface akka.javasdk.consumer.Consumer.Effect.Builder
Mark the 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 effect from an async operation that returns 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.
attach(MessageContent...) - Method in class akka.javasdk.agent.task.Task
Return a new task with the given content items attached.
attachments() - Method in class akka.javasdk.agent.task.Task
Content attached to this task (images, PDFs), or an empty list.
attachments() - Method in record class akka.javasdk.agent.task.TaskEntity.CreateRequest
Returns the value of the attachments record component.
attachments() - Method in record class akka.javasdk.agent.task.TaskEvent.TaskCreated
Returns the value of the attachments record component.
attachments() - Method in record class akka.javasdk.agent.task.TaskState
Returns the value of the attachments record component.
attributes() - Method in record class akka.javasdk.agent.SessionMemoryEntity.Event.AiMessageAdded
Returns the value of the attributes record component.
attributes() - Method in record class akka.javasdk.agent.SessionMessage.AiMessage
Returns the value of the attributes record component.
audience() - Method in interface akka.javasdk.JwtClaims
Get the audience, that is, the aud claim, as described in RFC 7519 section 4.1.3.
AUTO - Enum constant in enum class akka.javasdk.agent.MessageContent.ImageMessageContent.DetailLevel
Let the model automatically choose the appropriate detail level.
AutonomousAgent - Class in akka.javasdk.agent.autonomous
An autonomous AI agent component that operates independently to complete tasks.
AutonomousAgent() - Constructor for class akka.javasdk.agent.autonomous.AutonomousAgent
 
AutonomousAgent.TokenUsage - Record Class in akka.javasdk.agent.autonomous
Token usage statistics for an autonomous agent.
AutonomousAgentClient - Interface in akka.javasdk.client
Client for interacting with an AutonomousAgent.
azureOpenAi() - Static method in interface akka.javasdk.agent.ModelProvider
Settings for the Azure OpenAI Large Language Model provider.
AzureOpenAi(String, String, String, double, double, int, int, double, double, long, List<String>, String, String, Duration, Duration, int, List<HttpHeader>) - Constructor for record class akka.javasdk.agent.ModelProvider.AzureOpenAi
Creates an instance of a AzureOpenAi record class.

B

BacklogAccessGranted(String, String) - Constructor for record class akka.javasdk.agent.autonomous.Notification.BacklogAccessGranted
Creates an instance of a BacklogAccessGranted record class.
BacklogAssigned(String, String) - Constructor for record class akka.javasdk.agent.autonomous.Notification.BacklogAssigned
Creates an instance of a BacklogAssigned record class.
BacklogClosed() - Constructor for record class akka.javasdk.impl.agent.task.BacklogEvent.BacklogClosed
Creates an instance of a BacklogClosed record class.
BacklogClosed() - Constructor for record class akka.javasdk.impl.agent.task.BacklogNotification.BacklogClosed
Creates an instance of a BacklogClosed record class.
BacklogClosed(String, String) - Constructor for record class akka.javasdk.agent.autonomous.Notification.BacklogClosed
Creates an instance of a BacklogClosed record class.
BacklogCreated(String) - Constructor for record class akka.javasdk.impl.agent.task.BacklogEvent.BacklogCreated
Creates an instance of a BacklogCreated record class.
BacklogCreated(String) - Constructor for record class akka.javasdk.impl.agent.task.BacklogNotification.BacklogCreated
Creates an instance of a BacklogCreated record class.
BacklogEntity - Class in akka.javasdk.impl.agent.task
INTERNAL API Manages a shared backlog of task references with atomic claiming semantics.
BacklogEntity(EventSourcedEntityContext, NotificationPublisher<BacklogNotification>) - Constructor for class akka.javasdk.impl.agent.task.BacklogEntity
 
BacklogEntity.ClaimRequest - Record Class in akka.javasdk.impl.agent.task
 
BacklogEntity.TransferRequest - Record Class in akka.javasdk.impl.agent.task
 
BacklogEvent - Interface in akka.javasdk.impl.agent.task
INTERNAL API
BacklogEvent.BacklogClosed - Record Class in akka.javasdk.impl.agent.task
 
BacklogEvent.BacklogCreated - Record Class in akka.javasdk.impl.agent.task
 
BacklogEvent.TaskAdded - Record Class in akka.javasdk.impl.agent.task
 
BacklogEvent.TaskClaimed - Record Class in akka.javasdk.impl.agent.task
 
BacklogEvent.TaskReleased - Record Class in akka.javasdk.impl.agent.task
 
BacklogEvent.TaskTransferred - Record Class in akka.javasdk.impl.agent.task
 
BacklogEvent.UnclaimedCancelled - Record Class in akka.javasdk.impl.agent.task
 
backlogId() - Method in record class akka.javasdk.agent.autonomous.Notification.BacklogAccessGranted
Returns the value of the backlogId record component.
backlogId() - Method in record class akka.javasdk.agent.autonomous.Notification.BacklogAssigned
Returns the value of the backlogId record component.
backlogId() - Method in record class akka.javasdk.agent.autonomous.Notification.BacklogClosed
Returns the value of the backlogId record component.
backlogId() - Method in record class akka.javasdk.agent.autonomous.Notification.BacklogTaskClaimed
Returns the value of the backlogId record component.
backlogName() - Method in record class akka.javasdk.agent.autonomous.Notification.BacklogAccessGranted
Returns the value of the backlogName record component.
backlogName() - Method in record class akka.javasdk.agent.autonomous.Notification.BacklogAssigned
Returns the value of the backlogName record component.
backlogName() - Method in record class akka.javasdk.agent.autonomous.Notification.BacklogClosed
Returns the value of the backlogName record component.
backlogName() - Method in record class akka.javasdk.agent.autonomous.Notification.BacklogTaskClaimed
Returns the value of the backlogName record component.
BacklogNotification - Interface in akka.javasdk.impl.agent.task
INTERNAL API Notifications published by a BacklogEntity when its state changes.
BacklogNotification.BacklogClosed - Record Class in akka.javasdk.impl.agent.task
 
BacklogNotification.BacklogCreated - Record Class in akka.javasdk.impl.agent.task
 
BacklogNotification.TaskAdded - Record Class in akka.javasdk.impl.agent.task
 
BacklogNotification.TaskClaimed - Record Class in akka.javasdk.impl.agent.task
 
BacklogNotification.TaskReleased - Record Class in akka.javasdk.impl.agent.task
 
BacklogNotification.TaskTransferred - Record Class in akka.javasdk.impl.agent.task
 
BacklogNotification.UnclaimedCancelled - Record Class in akka.javasdk.impl.agent.task
 
BacklogState - Record Class in akka.javasdk.impl.agent.task
INTERNAL API State of a backlog entity — tracks task references and their claim status.
BacklogState(String, Map<String, BacklogState.Entry>, boolean) - Constructor for record class akka.javasdk.impl.agent.task.BacklogState
Creates an instance of a BacklogState record class.
BacklogState.Entry - Record Class in akka.javasdk.impl.agent.task
An entry in the backlog: task ID and who has claimed it (if anyone).
BacklogTaskClaimed(String, String, String) - Constructor for record class akka.javasdk.agent.autonomous.Notification.BacklogTaskClaimed
Creates an instance of a BacklogTaskClaimed record class.
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
badExamplesResourceDir() - Method in class akka.javasdk.agent.SimilarityGuard
 
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.GoogleAIGemini
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.MistralAi
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.
baseUrl() - Method in record class akka.javasdk.agent.ModelProvider.VertexAi
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.
bedrock() - Static method in interface akka.javasdk.agent.ModelProvider
Settings for the Bedrock Large Language Model provider.
Bedrock(String, String, boolean, boolean, int, int, Map<String, Object>, String, double, double, int, Duration, int, List<HttpHeader>) - Constructor for record class akka.javasdk.agent.ModelProvider.Bedrock
Deprecated.
Use constructor with prompt caching settings
Bedrock(String, String, boolean, boolean, int, int, Map<String, Object>, String, double, double, int, Duration, int, List<HttpHeader>, Optional<ModelProvider.BedrockPromptCachePlacement>) - Constructor for record class akka.javasdk.agent.ModelProvider.Bedrock
Creates an instance of a Bedrock record class.
beforeWrite(String, SessionMessage.AiMessage) - Method in interface akka.javasdk.agent.SessionMemoryInterceptor
Called immediately before an SessionMessage.AiMessage is persisted to session memory.
beforeWrite(String, SessionMessage.MultimodalUserMessage) - Method in interface akka.javasdk.agent.SessionMemoryInterceptor
Called immediately before a SessionMessage.MultimodalUserMessage is persisted to session memory.
beforeWrite(String, SessionMessage.ToolCallResponse) - Method in interface akka.javasdk.agent.SessionMemoryInterceptor
Called immediately before a SessionMessage.ToolCallResponse is persisted to session memory.
beforeWrite(String, SessionMessage.UserMessage) - Method in interface akka.javasdk.agent.SessionMemoryInterceptor
Called immediately before a SessionMessage.UserMessage is persisted to session memory.
body() - Method in record class akka.javasdk.http.StrictResponse
Returns the value of the body record component.
bucketName() - Method in interface akka.javasdk.objectstorage.ObjectStorage
 
build() - Method in class akka.javasdk.workflow.Workflow.WorkflowSettingsBuilder
Creates the final workflow configuration from this builder.
builder() - Static method in interface akka.javasdk.workflow.Workflow.WorkflowSettings
 

C

cacheSystemMessages() - Method in record class akka.javasdk.agent.ModelProvider.Anthropic
Returns the value of the cacheSystemMessages record component.
cacheTools() - Method in record class akka.javasdk.agent.ModelProvider.Anthropic
Returns the value of the cacheTools record component.
cancel(String) - Method in class akka.javasdk.agent.task.TaskEntity
 
Cancelled(String, String) - Constructor for exception class akka.javasdk.agent.task.TaskException.Cancelled
 
Cancelled(String, String, String) - Constructor for record class akka.javasdk.agent.task.TaskNotification.Cancelled
Creates an instance of a Cancelled record class.
CANCELLED - Enum constant in enum class akka.javasdk.agent.task.TaskStatus
Terminated before execution began, for example by a dependency failure.
cancelUnclaimed() - Method in class akka.javasdk.impl.agent.task.BacklogEntity
Remove all unclaimed tasks from the backlog.
canHandoffTo(Class<? extends AutonomousAgent>, Class<? extends AutonomousAgent>...) - Method in class akka.javasdk.agent.autonomous.capability.TaskAcceptance
Allow this agent to hand off tasks in this group to one of the specified agents.
capability(AgentCapability) - Method in interface akka.javasdk.agent.autonomous.AgentDefinition
Add a capability to this agent: task acceptance, delegation, etc.
capability(AgentCapability) - Method in interface akka.javasdk.agent.autonomous.AgentSetup
Add a capability for this instance, extending the static capabilities.
claim() - Element in annotation interface akka.javasdk.annotations.JWT.StaticClaim
The claim name needs to be a hardcoded literal (e.g.
claim(BacklogEntity.ClaimRequest) - Method in class akka.javasdk.impl.agent.task.BacklogEntity
Atomic first-come-first-served claim.
claimedBy() - Method in record class akka.javasdk.impl.agent.task.BacklogEntity.ClaimRequest
Returns the value of the claimedBy record component.
claimedBy() - Method in record class akka.javasdk.impl.agent.task.BacklogEvent.TaskClaimed
Returns the value of the claimedBy record component.
claimedBy() - Method in record class akka.javasdk.impl.agent.task.BacklogNotification.TaskClaimed
Returns the value of the claimedBy record component.
claimedBy() - Method in record class akka.javasdk.impl.agent.task.BacklogState.Entry
Returns the value of the claimedBy record component.
claimedBy(String) - Method in record class akka.javasdk.impl.agent.task.BacklogState
 
claimedTaskIds() - Method in record class akka.javasdk.impl.agent.task.BacklogState
 
ClaimRequest(String, String) - Constructor for record class akka.javasdk.impl.agent.task.BacklogEntity.ClaimRequest
Creates an instance of a ClaimRequest record class.
clear() - Method in record class akka.javasdk.agent.SessionMemoryEntity.State
Reset the in-memory history on deletion.
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.
close() - Method in class akka.javasdk.impl.agent.task.BacklogEntity
Close the backlog — no further modifications allowed.
closed() - Method in record class akka.javasdk.impl.agent.task.BacklogState
Returns the value of the closed record component.
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.
CommandException - Exception Class in akka.javasdk
An exception that can be thrown by user code to signal domain validation errors or business rule violations.
CommandException(String) - Constructor for exception class akka.javasdk.CommandException
 
Command Handlers - Search tag in class akka.javasdk.eventsourcedentity.EventSourcedEntity
Section
Command Handlers - Search tag in class akka.javasdk.keyvalueentity.KeyValueEntity
Section
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.
compact(long) - Method in record class akka.javasdk.agent.SessionMemoryEntity.State
Reset the in-memory history but record the journal sequence number where compaction took place, so a subsequent chunked read from the journal can skip the events that were superseded by the compaction summary.
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.
compactionSeqNr() - Method in record class akka.javasdk.agent.SessionMemoryEntity.State
Returns the value of the compactionSeqNr record component.
complete(TaskDefinition<R>, R) - Method in interface akka.javasdk.client.TaskClient
Complete a task with a typed result.
complete(String) - Method in class akka.javasdk.agent.task.TaskEntity
 
completeAsync(TaskDefinition<R>, R) - Method in interface akka.javasdk.client.TaskClient
Completed(String, String, String) - Constructor for record class akka.javasdk.agent.task.TaskNotification.Completed
Creates an instance of a Completed record class.
COMPLETED - Enum constant in enum class akka.javasdk.agent.task.TaskStatus
Finished successfully with a typed result.
Component - Annotation Interface in akka.javasdk.annotations
Assign metadata to a component (required for all component types aside from Endpoints).
COMPONENT_ID - Static variable in class akka.javasdk.agent.SessionMemoryEntity
 
componentClassName() - Method in interface akka.javasdk.UnhandledExceptionContext
Fully-qualified class name of the user component the exception originated in.
componentClient - Variable in class akka.javasdk.agent.evaluator.HallucinationEvaluator
 
componentClient - Variable in class akka.javasdk.agent.evaluator.SummarizationEvaluator
 
componentClient - Variable in class akka.javasdk.agent.evaluator.ToxicityEvaluator
 
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 - Variable in class akka.javasdk.agent.evaluator.HallucinationEvaluator
 
componentId - Variable in class akka.javasdk.agent.evaluator.SummarizationEvaluator
 
componentId - Variable in class akka.javasdk.agent.evaluator.ToxicityEvaluator
 
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.MultimodalUserMessageAdded
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 interface akka.javasdk.agent.SessionMessage
 
componentId() - Method in record class akka.javasdk.agent.SessionMessage.MultimodalUserMessage
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() - Method in interface akka.javasdk.UnhandledExceptionContext
Identifier for the component the exception originated in.
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.
config - Variable in class akka.javasdk.agent.evaluator.HallucinationEvaluator
 
config - Variable in class akka.javasdk.agent.evaluator.SummarizationEvaluator
 
config - Variable in class akka.javasdk.agent.evaluator.ToxicityEvaluator
 
config() - Method in interface akka.javasdk.agent.GuardrailContext
The config section for the specific guardrail.
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.
connectionTimeout() - Method in record class akka.javasdk.agent.ModelProvider.Anthropic
Returns the value of the connectionTimeout record component.
connectionTimeout() - Method in record class akka.javasdk.agent.ModelProvider.AzureOpenAi
Returns the value of the connectionTimeout record component.
connectionTimeout() - Method in record class akka.javasdk.agent.ModelProvider.GoogleAIGemini
Returns the value of the connectionTimeout record component.
connectionTimeout() - Method in record class akka.javasdk.agent.ModelProvider.HuggingFace
Returns the value of the connectionTimeout record component.
connectionTimeout() - Method in record class akka.javasdk.agent.ModelProvider.MistralAi
Returns the value of the connectionTimeout record component.
connectionTimeout() - Method in record class akka.javasdk.agent.ModelProvider.Ollama
Returns the value of the connectionTimeout record component.
connectionTimeout() - Method in record class akka.javasdk.agent.ModelProvider.OpenAi
Returns the value of the connectionTimeout record component.
connectionTimeout() - Method in record class akka.javasdk.agent.ModelProvider.VertexAi
Returns the value of the connectionTimeout 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 enable stream-based interaction between Akka services and other systems.
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 a message is handled.
Consumer.Effect.Builder - Interface in akka.javasdk.consumer
Builder for constructing Consumer effects that describe what the runtime should do after message processing.
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.
ContactAdded(String, String) - Constructor for record class akka.javasdk.agent.autonomous.Notification.ContactAdded
Creates an instance of a ContactAdded record class.
contactComponentId() - Method in record class akka.javasdk.agent.autonomous.Notification.ContactAdded
Returns the value of the contactComponentId record component.
contactInstanceId() - Method in record class akka.javasdk.agent.autonomous.Notification.ContactAdded
Returns the value of the contactInstanceId record component.
containsTask(String) - Method in record class akka.javasdk.impl.agent.task.BacklogState
 
content() - Method in record class akka.javasdk.agent.SessionMemoryEntity.Event.ToolResponseMessageAdded
Returns the value of the content record component.
contentLoader(ContentLoader) - Method in interface akka.javasdk.agent.Agent.Effect.Builder
Sets a custom content loader.
contentLoader(ContentLoader) - Method in interface akka.javasdk.agent.Agent.StreamEffect.Builder
Sets a custom content loader.
contentLoader(ContentLoader) - Method in interface akka.javasdk.agent.autonomous.AgentDefinition
Sets a custom content loader.
ContentLoader - Interface in akka.javasdk.agent
Interface for loading content from URIs.
ContentLoader.LoadedContent - Record Class in akka.javasdk.agent
Represents loaded content with its binary data and MIME type.
contents() - Method in record class akka.javasdk.agent.SessionMemoryEntity.Event.MultimodalUserMessageAdded
Returns the value of the contents record component.
contents() - Method in record class akka.javasdk.agent.SessionMessage.MultimodalUserMessage
Returns the value of the contents record component.
contents() - Method in record class akka.javasdk.agent.UserMessage
Returns the value of the contents record component.
contentType - Variable in class akka.javasdk.objectstorage.ObjectMetadata
Content type, if set when the object was stored.
context() - Method in class akka.javasdk.agent.Agent
Additional context and metadata for a command handler.
context() - Method in record class akka.javasdk.agent.task.TaskEntity.ReassignRequest
Returns the value of the context record component.
context() - Method in record class akka.javasdk.agent.task.TaskEvent.TaskReassigned
Returns the value of the context record component.
Context - Interface in akka.javasdk
Root class of all contexts.
ConversationCreated(String, String, String, List<String>, List<String>) - Constructor for record class akka.javasdk.agent.autonomous.Notification.ConversationCreated
Creates an instance of a ConversationCreated record class.
ConversationEnded(String) - Constructor for record class akka.javasdk.agent.autonomous.Notification.ConversationEnded
Creates an instance of a ConversationEnded record class.
conversationId() - Method in record class akka.javasdk.agent.autonomous.Notification.ConversationCreated
Returns the value of the conversationId record component.
conversationId() - Method in record class akka.javasdk.agent.autonomous.Notification.ConversationEnded
Returns the value of the conversationId record component.
conversationId() - Method in record class akka.javasdk.agent.autonomous.Notification.ConversationJoined
Returns the value of the conversationId record component.
conversationId() - Method in record class akka.javasdk.agent.autonomous.Notification.ConversationParticipantReady
Returns the value of the conversationId record component.
conversationId() - Method in record class akka.javasdk.agent.autonomous.Notification.ConversationParticipantSetupFailed
Returns the value of the conversationId record component.
conversationId() - Method in record class akka.javasdk.agent.autonomous.Notification.ConversationTurnReceived
Returns the value of the conversationId record component.
conversationId() - Method in record class akka.javasdk.agent.autonomous.Notification.ParticipantTurnSubmitted
Returns the value of the conversationId record component.
ConversationJoined(String, String, String) - Constructor for record class akka.javasdk.agent.autonomous.Notification.ConversationJoined
Creates an instance of a ConversationJoined record class.
ConversationParticipantReady(String, String, String) - Constructor for record class akka.javasdk.agent.autonomous.Notification.ConversationParticipantReady
Creates an instance of a ConversationParticipantReady record class.
ConversationParticipantSetupFailed(String, String, String, String) - Constructor for record class akka.javasdk.agent.autonomous.Notification.ConversationParticipantSetupFailed
Creates an instance of a ConversationParticipantSetupFailed record class.
ConversationTurnReceived(String, String, String) - Constructor for record class akka.javasdk.agent.autonomous.Notification.ConversationTurnReceived
Creates an instance of a ConversationTurnReceived record class.
correlationId() - Method in interface akka.javasdk.UnhandledExceptionContext
The correlation id surfaced to the client and present in the runtime log MDC at the time the exception was caught.
create() - Static method in interface akka.javasdk.agent.autonomous.AgentSetup
Create an empty agent setup.
create(Task<R>) - Method in interface akka.javasdk.client.TaskClient
Create a task entity.
create(TaskEntity.CreateRequest) - Method in class akka.javasdk.agent.task.TaskEntity
 
create(ObjectStorage, String) - Static method in record class akka.javasdk.agent.MessageContent.ImageUrlMessageContent
Creates image content referencing an object in a bucket via the object:// URI scheme.
create(ObjectStorage, String) - Static method in record class akka.javasdk.agent.MessageContent.PdfUrlMessageContent
Creates PDF content referencing an object in a bucket via the object:// URI scheme.
create(String) - Method in class akka.javasdk.impl.agent.task.BacklogEntity
Create this backlog with a name.
createAsync(Task<R>) - Method in interface akka.javasdk.client.TaskClient
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.
CreateRequest(String, String, String, String, List<String>, List<TaskAttachment>, List<String>) - Constructor for record class akka.javasdk.agent.task.TaskEntity.CreateRequest
Creates an instance of a CreateRequest record class.
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
If you don't need streaming you can throw an exception from this method.
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.
currentTask() - Method in class akka.javasdk.agent.autonomous.AgentState
The task currently being worked on, if any.
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

data - Variable in class akka.javasdk.objectstorage.StorageObject
Full content of the object.
data() - Method in record class akka.javasdk.agent.ContentLoader.LoadedContent
Returns the value of the data record component.
data() - Method in record class akka.javasdk.agent.ImageLoader.LoadedImage
Deprecated.
Returns the value of the data record component.
data() - Method in interface akka.javasdk.agent.MessageContent.DataMessageContent
 
data() - Method in record class akka.javasdk.impl.agent.DataMessageContentImpl.Image
Returns the value of the data record component.
data() - Method in record class akka.javasdk.impl.agent.DataMessageContentImpl.Pdf
Returns the value of the data record component.
datacontenttype() - Method in interface akka.javasdk.CloudEvent
The data content type of this CloudEvent.
DataMessageContentImpl - Class in akka.javasdk.impl.agent
DataMessageContentImpl.Image - Record Class in akka.javasdk.impl.agent
 
DataMessageContentImpl.Pdf - Record Class in akka.javasdk.impl.agent
 
dataschema() - Method in interface akka.javasdk.CloudEvent
The data schema of this CloudEvent.
Deactivated() - Constructor for record class akka.javasdk.agent.autonomous.Notification.Deactivated
Creates an instance of a Deactivated record class.
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.
defaultStepRecoverStrategy() - Method in interface akka.javasdk.workflow.Workflow.WorkflowSettings
 
defaultStepRecovery(Workflow.RecoverStrategy<?>) - Method in class akka.javasdk.workflow.Workflow.WorkflowSettingsBuilder
Define a default recovery strategy for all steps.
defaultStepTimeout() - Method in interface akka.javasdk.workflow.Workflow.WorkflowSettings
 
defaultStepTimeout(Duration) - Method in class akka.javasdk.workflow.Workflow.WorkflowSettingsBuilder
Define a default timeout duration for all steps.
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.
define() - Method in class akka.javasdk.agent.autonomous.AutonomousAgent
Start building an agent definition.
define(String) - Static method in class akka.javasdk.agent.task.TaskTemplate
Define a new task template with the given name.
definition() - Method in class akka.javasdk.agent.autonomous.AutonomousAgent
Define this autonomous agent.
delegate - Variable in class akka.javasdk.agent.MemoryProvider.InterceptedMemoryProvider
 
Delegation - Interface in akka.javasdk.agent.autonomous.capability
Declares that an agent can delegate subtasks to other agents.
delegationCount() - Method in record class akka.javasdk.agent.autonomous.Notification.DelegationStarted
Returns the value of the delegationCount record component.
DelegationResolved(int, int, List<String>, List<String>) - Constructor for record class akka.javasdk.agent.autonomous.Notification.DelegationResolved
Creates an instance of a DelegationResolved record class.
DelegationStarted(List<String>, int, List<String>, List<String>) - Constructor for record class akka.javasdk.agent.autonomous.Notification.DelegationStarted
Creates an instance of a DelegationStarted record class.
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.objectstorage.ObjectStorage
Delete the object with the given key.
delete(String) - Method in interface akka.javasdk.timer.TimerScheduler
Delete an existing timer.
delete(String) - Method in interface akka.javasdk.workflow.Workflow.Effect.Builder
Finish and delete the workflow execution with a reason description.
delete(String) - Method in interface akka.javasdk.workflow.Workflow.Effect.PersistenceEffectBuilder
Finish and delete the workflow execution with a reason description.
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.objectstorage.ObjectStorage
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
Deletes the view row.
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.
DependencyResolved(String, String, boolean, String) - Constructor for record class akka.javasdk.agent.autonomous.Notification.DependencyResolved
Creates an instance of a DependencyResolved record class.
dependencyTaskId() - Method in record class akka.javasdk.agent.autonomous.Notification.DependencyResolved
Returns the value of the dependencyTaskId record component.
dependencyTaskIds() - Method in class akka.javasdk.agent.task.Task
Task IDs that must complete before this task can start, or an empty list.
dependencyTaskIds() - Method in record class akka.javasdk.agent.task.TaskEntity.CreateRequest
Returns the value of the dependencyTaskIds record component.
dependencyTaskIds() - Method in record class akka.javasdk.agent.task.TaskEvent.TaskCreated
Returns the value of the dependencyTaskIds record component.
dependencyTaskIds() - Method in record class akka.javasdk.agent.task.TaskState
Returns the value of the dependencyTaskIds record component.
dependsOn(String...) - Method in class akka.javasdk.agent.task.Task
Return a new task that depends on the given task IDs.
deploymentName() - Method in record class akka.javasdk.agent.ModelProvider.AzureOpenAi
Returns the value of the deploymentName record component.
description() - Method in record class akka.javasdk.agent.AgentRegistry.AgentInfo
Returns the value of the description record component.
description() - Method in class akka.javasdk.agent.task.Task
 
description() - Method in interface akka.javasdk.agent.task.TaskDefinition
The description of this task — what kind of work it represents.
description() - Method in record class akka.javasdk.agent.task.TaskEntity.CreateRequest
Returns the value of the description record component.
description() - Method in record class akka.javasdk.agent.task.TaskEvent.TaskCreated
Returns the value of the description record component.
description() - Method in record class akka.javasdk.agent.task.TaskSnapshot
Returns the value of the description record component.
description() - Method in record class akka.javasdk.agent.task.TaskState
Returns the value of the description record component.
description() - Method in class akka.javasdk.agent.task.TaskTemplate
 
description() - Element in annotation interface akka.javasdk.annotations.Component
A description of what this component does.
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(String) - Method in class akka.javasdk.agent.task.Task
Set the description of this task — what kind of work it represents.
description(String) - Method in class akka.javasdk.agent.task.TaskTemplate
Set the description of this task — what kind of work it represents.
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.
detailLevel() - Method in interface akka.javasdk.agent.MessageContent.ImageDataMessageContent
 
detailLevel() - Method in record class akka.javasdk.agent.MessageContent.ImageUrlMessageContent
Returns the value of the detailLevel record component.
detailLevel() - Method in record class akka.javasdk.agent.SessionMessage.MessageContent.ImageUriMessageContent
Returns the value of the detailLevel record component.
detailLevel() - Method in record class akka.javasdk.agent.task.TaskAttachment
Returns the value of the detailLevel record component.
detailLevel() - Method in record class akka.javasdk.impl.agent.DataMessageContentImpl.Image
Returns the value of the detailLevel record component.
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.
document() - Method in record class akka.javasdk.agent.evaluator.SummarizationEvaluator.EvaluationRequest
Returns the value of the document record component.
done() - Method in interface akka.javasdk.consumer.Consumer.Effect.Builder
Mark the message as successfully 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
Returns the Effect Builder for constructing effects that describe what the runtime should do after message processing.
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 method in record class akka.javasdk.agent.task.TaskState
 
empty() - Static method in interface akka.javasdk.eventsourcedentity.ReplicationFilter
Creates an empty replication filter.
empty() - Static method in record class akka.javasdk.impl.agent.task.BacklogState
 
empty() - Static method in interface akka.javasdk.keyvalueentity.ReplicationFilter
Creates an empty replication filter.
empty(String) - Static method in record class akka.javasdk.workflow.Workflow.StepSettings
 
EMPTY - Static variable in record class akka.javasdk.agent.SessionHistory
 
EMPTY - Static variable in record class akka.javasdk.agent.SessionMessage.TokenUsage
 
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.agent.task.TaskEntity
 
emptyState() - Method in class akka.javasdk.eventsourcedentity.EventSourcedEntity
Returns the initial empty state object for this entity.
emptyState() - Method in class akka.javasdk.impl.agent.task.BacklogEntity
 
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.
EnableReplicationFilter - Annotation Interface in akka.javasdk.annotations
Enables the replication filter feature for an Event Sourced Entity, allowing runtime control of which regions participate in event replication.
encodeToAkkaByteString(T) - Static method in class akka.javasdk.JsonSupport
Encode the given value as JSON using Jackson.
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.
end(String) - Method in interface akka.javasdk.workflow.Workflow.Effect.Builder
Finish the workflow execution with a reason description.
end(String) - Method in interface akka.javasdk.workflow.Workflow.Effect.PersistenceEffectBuilder
Finish the workflow execution with a reason description.
endpoint() - Method in record class akka.javasdk.agent.ModelProvider.AzureOpenAi
Returns the value of the endpoint record component.
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.
entries() - Method in record class akka.javasdk.impl.agent.task.BacklogState
 
entriesSource() - Method in interface akka.javasdk.client.ViewStreamMethodRef
 
entriesSource(A1) - Method in interface akka.javasdk.client.ViewStreamMethodRef1
 
entriesSource(A1, Optional<Instant>) - Method in interface akka.javasdk.client.ViewStreamMethodRef1
 
entriesSource(Optional<Instant>) - Method in interface akka.javasdk.client.ViewStreamMethodRef
 
entry() - Method in record class akka.javasdk.view.EntryWithMetadata
Returns the value of the entry record component.
Entry(String, Optional<String>) - Constructor for record class akka.javasdk.impl.agent.task.BacklogState.Entry
Creates an instance of a Entry record class.
EntryWithMetadata<T> - Record Class in akka.javasdk.view
 
EntryWithMetadata(T, Metadata) - Constructor for record class akka.javasdk.view.EntryWithMetadata
Creates an instance of a EntryWithMetadata record class.
equals(Object) - Method in record class akka.javasdk.agent.Agent.AgentReply
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.agent.Agent.TokenUsage
Indicates whether some other object is "equal to" this one.
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.autonomous.AutonomousAgent.TokenUsage
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.agent.autonomous.Notification.Activated
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.agent.autonomous.Notification.BacklogAccessGranted
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.agent.autonomous.Notification.BacklogAssigned
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.agent.autonomous.Notification.BacklogClosed
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.agent.autonomous.Notification.BacklogTaskClaimed
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.agent.autonomous.Notification.ContactAdded
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.agent.autonomous.Notification.ConversationCreated
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.agent.autonomous.Notification.ConversationEnded
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.agent.autonomous.Notification.ConversationJoined
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.agent.autonomous.Notification.ConversationParticipantReady
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.agent.autonomous.Notification.ConversationParticipantSetupFailed
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.agent.autonomous.Notification.ConversationTurnReceived
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.agent.autonomous.Notification.Deactivated
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.agent.autonomous.Notification.DelegationResolved
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.agent.autonomous.Notification.DelegationStarted
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.agent.autonomous.Notification.DependencyResolved
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.agent.autonomous.Notification.HandoffReceived
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.agent.autonomous.Notification.HandoffStarted
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.agent.autonomous.Notification.IterationCompleted
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.agent.autonomous.Notification.IterationFailed
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.agent.autonomous.Notification.IterationStarted
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.agent.autonomous.Notification.MessageReceived
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.agent.autonomous.Notification.ParticipantTurnSubmitted
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.agent.autonomous.Notification.RepeatedIterationFailure
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.agent.autonomous.Notification.Resumed
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.agent.autonomous.Notification.Stopped
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.agent.autonomous.Notification.Suspended
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.agent.autonomous.Notification.TaskApproachingMaxIterations
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.agent.autonomous.Notification.TaskAssigned
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.agent.autonomous.Notification.TaskCancelled
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.agent.autonomous.Notification.TaskCompleted
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.agent.autonomous.Notification.TaskDependencyStuck
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.agent.autonomous.Notification.TaskDependencyWait
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.agent.autonomous.Notification.TaskFailed
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.agent.autonomous.Notification.TaskResultRejected
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.agent.autonomous.Notification.TaskStarted
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.agent.autonomous.Notification.TaskStruggleDetected
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.agent.autonomous.Notification.TeamCreated
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.agent.autonomous.Notification.TeamDisbanded
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.agent.autonomous.Notification.TeamJoined
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.agent.autonomous.Notification.TeamMemberReady
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.agent.autonomous.Notification.TeamMemberSetupFailed
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.agent.autonomous.Notification.TeamMemberStopped
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.agent.autonomous.Notification.WorkerTaskCompleted
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.agent.autonomous.Notification.WorkerTaskReceived
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.agent.ContentLoader.LoadedContent
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.agent.evaluator.HallucinationEvaluator.EvaluationRequest
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.agent.evaluator.HallucinationEvaluator.Result
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.agent.evaluator.SummarizationEvaluator.EvaluationRequest
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.agent.evaluator.SummarizationEvaluator.Result
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.agent.evaluator.ToxicityEvaluator.Result
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.agent.Guardrail.Result
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.agent.ImageLoader.LoadedImage
Deprecated.
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.agent.MemoryFilter.Exclude
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.agent.MemoryFilter.Include
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.MessageContent.ImageMessageContent
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.agent.MessageContent.ImageUrlMessageContent
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.agent.MessageContent.PdfMessageContent
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.agent.MessageContent.PdfUrlMessageContent
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.agent.MessageContent.TextMessageContent
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.AzureOpenAi
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.agent.ModelProvider.Bedrock
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.MistralAi
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.ModelProvider.VertexAi
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.SessionHistoryResult.Loaded
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.agent.SessionHistoryResult.Truncated
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.AddMultimodalInteractionCmd
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.MultimodalUserMessageAdded
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.MessageContent.ImageUriMessageContent
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.agent.SessionMessage.MessageContent.PdfUriMessageContent
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.agent.SessionMessage.MessageContent.TextMessageContent
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.agent.SessionMessage.MultimodalUserMessage
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.agent.SessionMessage.TokenUsage
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.agent.task.TaskAttachment
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.agent.task.TaskEntity.CreateRequest
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.agent.task.TaskEntity.ReassignRequest
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.agent.task.TaskEntity.RejectResultRequest
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.agent.task.TaskEvent.TaskAssigned
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.agent.task.TaskEvent.TaskCancelled
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.agent.task.TaskEvent.TaskCompleted
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.agent.task.TaskEvent.TaskCreated
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.agent.task.TaskEvent.TaskFailed
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.agent.task.TaskEvent.TaskReassigned
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.agent.task.TaskEvent.TaskResultRejected
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.agent.task.TaskEvent.TaskStarted
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.agent.task.TaskKey
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.agent.task.TaskNotification.Cancelled
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.agent.task.TaskNotification.Completed
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.agent.task.TaskNotification.Failed
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.agent.task.TaskNotification.ResultRejected
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.agent.task.TaskRule.Result.Accepted
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.agent.task.TaskRule.Result.Rejected
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.agent.task.TaskSnapshot
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.agent.task.TaskState
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.agent.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.DataMessageContentImpl.Image
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.impl.agent.DataMessageContentImpl.Pdf
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 record class akka.javasdk.impl.agent.task.BacklogEntity.ClaimRequest
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.impl.agent.task.BacklogEntity.TransferRequest
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.impl.agent.task.BacklogEvent.BacklogClosed
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.impl.agent.task.BacklogEvent.BacklogCreated
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.impl.agent.task.BacklogEvent.TaskAdded
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.impl.agent.task.BacklogEvent.TaskClaimed
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.impl.agent.task.BacklogEvent.TaskReleased
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.impl.agent.task.BacklogEvent.TaskTransferred
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.impl.agent.task.BacklogEvent.UnclaimedCancelled
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.impl.agent.task.BacklogNotification.BacklogClosed
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.impl.agent.task.BacklogNotification.BacklogCreated
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.impl.agent.task.BacklogNotification.TaskAdded
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.impl.agent.task.BacklogNotification.TaskClaimed
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.impl.agent.task.BacklogNotification.TaskReleased
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.impl.agent.task.BacklogNotification.TaskTransferred
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.impl.agent.task.BacklogNotification.UnclaimedCancelled
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.impl.agent.task.BacklogState.Entry
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.impl.agent.task.BacklogState
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in class akka.javasdk.Principal.LocalService
 
equals(Object) - Method in record class akka.javasdk.view.EntryWithMetadata
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.workflow.Workflow.CommandHandler.NoArgCommandHandler
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.workflow.Workflow.CommandHandler.OneArgCommandHandler
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.workflow.Workflow.PauseSettings
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.workflow.Workflow.PauseSettingsBuilder
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.workflow.Workflow.RecoverStrategy
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.workflow.Workflow.RecoverStrategy.MaxRetries
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.workflow.Workflow.RecoverStrategy.RecoveryInput
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.workflow.Workflow.StepHandler.NoArgStepHandler
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.workflow.Workflow.StepHandler.OneArgStepHandler
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.workflow.Workflow.StepMethod
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class akka.javasdk.workflow.Workflow.StepSettings
Indicates whether some other object is "equal to" this one.
error(StatusCode) - Static method in class akka.javasdk.http.HttpException
 
error(StatusCode, String) - Static method in class akka.javasdk.http.HttpException
 
error(CommandException) - Method in interface akka.javasdk.agent.Agent.Effect.Builder
Create an error reply.
error(CommandException) - Method in interface akka.javasdk.agent.Agent.StreamEffect.Builder
Create an error reply.
error(CommandException) - Method in interface akka.javasdk.eventsourcedentity.EventSourcedEntity.Effect.Builder
Create an error reply.
error(CommandException) - Method in interface akka.javasdk.keyvalueentity.KeyValueEntity.Effect.Builder
Create an error reply.
error(CommandException) - Method in interface akka.javasdk.workflow.Workflow.Effect.Builder
Create an error reply.
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.
eTag - Variable in class akka.javasdk.objectstorage.ObjectMetadata
Entity tag (opaque identifier for the object version), if provided by the backend.
evaluate(HallucinationEvaluator.EvaluationRequest) - Method in class akka.javasdk.agent.evaluator.HallucinationEvaluator
 
evaluate(SummarizationEvaluator.EvaluationRequest) - Method in class akka.javasdk.agent.evaluator.SummarizationEvaluator
 
evaluate(String) - Method in class akka.javasdk.agent.evaluator.ToxicityEvaluator
 
evaluate(String) - Method in class akka.javasdk.agent.SimilarityGuard
 
evaluate(String) - Method in interface akka.javasdk.agent.TextGuardrail
Evaluates if the text passes the guardrail or not.
EvaluationRequest(String, String) - Constructor for record class akka.javasdk.agent.evaluator.SummarizationEvaluator.EvaluationRequest
Creates an instance of a EvaluationRequest record class.
EvaluationRequest(String, String, String) - Constructor for record class akka.javasdk.agent.evaluator.HallucinationEvaluator.EvaluationRequest
Creates an instance of a EvaluationRequest record class.
EvaluationResult - Interface in akka.javasdk.agent
When an Agent returns an EvaluationResult it is tracked in metrics and traces.
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.
EventWithMetadata<E> - Class in akka.javasdk.eventsourcedentity
 
EventWithMetadata(E, Metadata) - Constructor for class akka.javasdk.eventsourcedentity.EventWithMetadata
 
Example Implementation - Search tag in class akka.javasdk.eventsourcedentity.EventSourcedEntity
Section
Example Implementation - Search tag in class akka.javasdk.keyvalueentity.KeyValueEntity
Section
Exclude(Set<String>, Set<String>) - Constructor for record class akka.javasdk.agent.MemoryFilter.Exclude
Creates an instance of a Exclude record class.
excludeFromAgentId(String) - Static method in interface akka.javasdk.agent.MemoryFilter
Creates a filter supplier that excludes messages from the specified agent component id.
excludeFromAgentId(String) - Method in interface akka.javasdk.agent.MemoryFilter.MemoryFilterSupplier
Adds a filter to exclude messages from the specified agent component id.
excludeFromAgentIds(Set<String>) - Static method in interface akka.javasdk.agent.MemoryFilter
Creates a filter supplier that excludes messages from the specified agent component ids.
excludeFromAgentIds(Set<String>) - Method in interface akka.javasdk.agent.MemoryFilter.MemoryFilterSupplier
Adds a filter to exclude messages from the specified agent component ids.
excludeFromAgentRole(String) - Static method in interface akka.javasdk.agent.MemoryFilter
Creates a filter supplier that excludes messages from agents with the specified role.
excludeFromAgentRole(String) - Method in interface akka.javasdk.agent.MemoryFilter.MemoryFilterSupplier
Adds a filter to exclude messages from agents with the specified role.
excludeFromAgentRoles(Set<String>) - Static method in interface akka.javasdk.agent.MemoryFilter
Creates a filter supplier that excludes messages from agents with the specified roles.
excludeFromAgentRoles(Set<String>) - Method in interface akka.javasdk.agent.MemoryFilter.MemoryFilterSupplier
Adds a filter to exclude messages from agents with the specified roles.
excludeRegion(String) - Method in interface akka.javasdk.eventsourcedentity.ReplicationFilter.Builder
Removes a region from this replication filter.
excludeRegion(String) - Static method in interface akka.javasdk.eventsourcedentity.ReplicationFilter
Creates a replication filter that excludes the specified region.
excludeRegion(String) - Method in interface akka.javasdk.keyvalueentity.ReplicationFilter.Builder
Removes a region from this replication filter.
excludeRegion(String) - Static method in interface akka.javasdk.keyvalueentity.ReplicationFilter
Creates a replication filter that excludes the specified region.
excludeRegions(Set<String>) - Method in interface akka.javasdk.eventsourcedentity.ReplicationFilter.Builder
Removes multiple regions from this replication filter.
excludeRegions(Set<String>) - Static method in interface akka.javasdk.eventsourcedentity.ReplicationFilter
Creates a replication filter that excludes the specified regions.
excludeRegions(Set<String>) - Method in interface akka.javasdk.keyvalueentity.ReplicationFilter.Builder
Removes multiple regions from this replication filter.
excludeRegions(Set<String>) - Static method in interface akka.javasdk.keyvalueentity.ReplicationFilter
Creates a replication filter that excludes the specified regions.
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.
expireAfter(Duration) - Method in interface akka.javasdk.eventsourcedentity.EventSourcedEntity.Effect.OnSuccessBuilder
Set a time-to-live for the entity.
expireAfter(Duration) - Method in interface akka.javasdk.keyvalueentity.KeyValueEntity.Effect.OnSuccessBuilder
Sets a time-to-live for this entity.
explanation() - Method in interface akka.javasdk.agent.EvaluationResult
 
explanation() - Method in record class akka.javasdk.agent.evaluator.HallucinationEvaluator.Result
Returns the value of the explanation record component.
explanation() - Method in record class akka.javasdk.agent.evaluator.SummarizationEvaluator.Result
Returns the value of the explanation record component.
explanation() - Method in record class akka.javasdk.agent.evaluator.ToxicityEvaluator.Result
Returns the value of the explanation record component.
explanation() - Method in record class akka.javasdk.agent.Guardrail.Result
Returns the value of the explanation record component.

F

fail(String) - Method in class akka.javasdk.agent.task.TaskEntity
 
fail(String) - Method in interface akka.javasdk.client.TaskClient
Fail a task with a reason.
failAsync(String) - Method in interface akka.javasdk.client.TaskClient
failed() - Method in record class akka.javasdk.agent.autonomous.Notification.DelegationResolved
Returns the value of the failed record component.
Failed(String, String) - Constructor for exception class akka.javasdk.agent.task.TaskException.Failed
 
Failed(String, String, String) - Constructor for record class akka.javasdk.agent.task.TaskNotification.Failed
Creates an instance of a Failed record class.
FAILED - Enum constant in enum class akka.javasdk.agent.task.TaskStatus
Failed during execution, either by the model's decision or because the iteration limit was reached.
failedSubtaskIds() - Method in record class akka.javasdk.agent.autonomous.Notification.DelegationResolved
Returns the value of the failedSubtaskIds record component.
failoverStepInput() - Method in record class akka.javasdk.workflow.Workflow.RecoverStrategy
Returns the value of the failoverStepInput record component.
failoverStepName() - Method in record class akka.javasdk.workflow.Workflow.RecoverStrategy
Returns the value of the failoverStepName record component.
failoverTo(Function<W, Workflow.StepEffect>) - Static method in record class akka.javasdk.workflow.Workflow.RecoverStrategy
In case of a step fails, don't retry but transition to a given step method.
failoverTo(Function<W, Workflow.StepEffect>) - Method in record class akka.javasdk.workflow.Workflow.RecoverStrategy.MaxRetries
Once max retries are exceeded, transition to a given step method.
failoverTo(Function2<W, I, Workflow.StepEffect>) - Static method in record class akka.javasdk.workflow.Workflow.RecoverStrategy
In case of a step fails, don't retry but transition to a given step method with input parameter.
failoverTo(Function2<W, I, Workflow.StepEffect>) - Method in record class akka.javasdk.workflow.Workflow.RecoverStrategy.MaxRetries
Once max retries are exceeded, transition to a given step method with input parameter.
failureReason() - Method in record class akka.javasdk.agent.task.TaskSnapshot
Returns the value of the failureReason record component.
failureReason() - Method in record class akka.javasdk.agent.task.TaskState
Returns the value of the failureReason record component.
fetchHistory(SessionMemoryEntity.GetHistoryCmd) - Method in class akka.javasdk.agent.SessionMemoryEntity
Like SessionMemoryEntity.getHistory(akka.javasdk.agent.SessionMemoryEntity.GetHistoryCmd) but signals via a SessionHistoryResult.Truncated reply when the entity has dropped older messages because of its size limit.
fillInStackTrace() - Method in exception class akka.javasdk.CommandException
 
filtered(MemoryFilter.MemoryFilterSupplier) - Method in record class akka.javasdk.agent.MemoryProvider.LimitedWindowMemoryProvider
Creates a new memory provider with multiple filters applied.
filters() - Method in record class akka.javasdk.agent.MemoryProvider.LimitedWindowMemoryProvider
Returns the value of the filters record component.
forAgent() - Method in interface akka.javasdk.client.ComponentClient
Select Agent as a call target component.
forAutonomousAgent(Class<T>, String) - Method in interface akka.javasdk.client.ComponentClient
Select an AutonomousAgent as a call target component.
forbidden() - Static method in class akka.javasdk.http.HttpException
 
forbidden(String) - Static method in class akka.javasdk.http.HttpException
 
forBucket(String) - Method in interface akka.javasdk.objectstorage.ObjectStorageProvider
Returns a client for the named bucket.
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.
forName(String, String, String) - Static method in exception class akka.javasdk.agent.task.TaskException.TypeMismatch
 
forResultType(String, String, String) - Static method in exception class akka.javasdk.agent.task.TaskException.TypeMismatch
 
forTask(String) - Method in interface akka.javasdk.client.ComponentClient
Select a task for querying its status and result.
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.
frequencyPenalty() - Method in record class akka.javasdk.agent.ModelProvider.AzureOpenAi
Returns the value of the frequencyPenalty record component.
frequencyPenalty() - Method in record class akka.javasdk.agent.ModelProvider.MistralAi
Returns the value of the frequencyPenalty record component.
from(byte[]) - Static method in record class akka.javasdk.agent.ContentLoader.LoadedContent
 
from(MessageContent...) - Static method in record class akka.javasdk.agent.UserMessage
 
from(String) - Static method in record class akka.javasdk.agent.MessageContent.TextMessageContent
Creates text content from a string.
from(String) - Static method in record class akka.javasdk.agent.UserMessage
 
fromComponentId() - Method in record class akka.javasdk.agent.autonomous.Notification.MessageReceived
Returns the value of the fromComponentId record 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.AzureOpenAi
 
fromConfig(Config) - Static method in record class akka.javasdk.agent.ModelProvider.Bedrock
 
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.MistralAi
 
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(Config) - Static method in record class akka.javasdk.agent.ModelProvider.VertexAi
 
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.
fromInstanceId() - Method in record class akka.javasdk.agent.autonomous.Notification.MessageReceived
Returns the value of the fromInstanceId record component.
fromMessageContent(MessageContent) - Static method in record class akka.javasdk.agent.task.TaskAttachment
Convert a MessageContent to a serializable TaskAttachment.
fromSequenceNr() - Method in record class akka.javasdk.agent.SessionHistoryResult.Truncated
Returns the value of the fromSequenceNr record component.
fromServer(String) - Static method in interface akka.javasdk.agent.RemoteMcpTools
 
fromService(String) - Static method in interface akka.javasdk.agent.RemoteMcpTools
 
fromUri(String) - Static method in record class akka.javasdk.agent.MessageContent.ImageMessageContent
Creates image content from a URI string with automatic detail level.
fromUri(String) - Static method in record class akka.javasdk.agent.MessageContent.PdfMessageContent
Creates PDF content from a URI string.
fromUri(URI) - Static method in record class akka.javasdk.agent.MessageContent.ImageMessageContent
Creates image content from a URI with automatic detail level.
fromUri(URI) - Static method in record class akka.javasdk.agent.MessageContent.PdfMessageContent
Creates PDF content from a URI.
fromUri(URI, MessageContent.ImageMessageContent.DetailLevel) - Static method in record class akka.javasdk.agent.MessageContent.ImageMessageContent
Creates image content from a URI with a specific detail level.
fromUri(URI, MessageContent.ImageMessageContent.DetailLevel, String) - Static method in record class akka.javasdk.agent.MessageContent.ImageMessageContent
Creates image content from a URI with a specific detail level and explicit mime type.
fromUrl(String) - Static method in record class akka.javasdk.agent.MessageContent.ImageMessageContent
Deprecated, for removal: This API element is subject to removal in a future version.
fromUrl(String) - Static method in record class akka.javasdk.agent.MessageContent.PdfMessageContent
Deprecated, for removal: This API element is subject to removal in a future version.
fromUrl(URL) - Static method in record class akka.javasdk.agent.MessageContent.ImageMessageContent
Deprecated, for removal: This API element is subject to removal in a future version.
fromUrl(URL) - Static method in record class akka.javasdk.agent.MessageContent.PdfMessageContent
Deprecated, for removal: This API element is subject to removal in a future version.
fromUrl(URL, MessageContent.ImageMessageContent.DetailLevel) - Static method in record class akka.javasdk.agent.MessageContent.ImageMessageContent
Deprecated, for removal: This API element is subject to removal in a future version.
fromUrl(URL, MessageContent.ImageMessageContent.DetailLevel, String) - Static method in record class akka.javasdk.agent.MessageContent.ImageMessageContent
Deprecated, for removal: This API element is subject to removal in a future version.
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(TaskDefinition<R>) - Method in interface akka.javasdk.client.TaskClient
Get a point-in-time snapshot of the task's current state.
get(String) - Method in interface akka.javasdk.Metadata
Get the string value for the given key, if found.
get(String) - Method in interface akka.javasdk.objectstorage.ObjectStorage
Retrieve an object, returning both its metadata and full content, or Optional.empty() if no object exists for the given key.
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 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.
getAsync(TaskDefinition<R>) - Method in interface akka.javasdk.client.TaskClient
getAsync(String) - Method in interface akka.javasdk.objectstorage.ObjectStorage
Async variant of ObjectStorage.get(String).
getBinary(String) - Method in interface akka.javasdk.Metadata
Deprecated, for removal: This API element is subject to removal in a future version.
binary not supported, always returns empty. Use Metadata.get(String).
getBinaryAll(String) - Method in interface akka.javasdk.Metadata
Deprecated, for removal: This API element is subject to removal in a future version.
binary not supported, always returns empty. Use Metadata.getAll(String).
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.
getEvent() - Method in class akka.javasdk.eventsourcedentity.EventWithMetadata
 
getHistory(SessionMemoryEntity.GetHistoryCmd) - Method in class akka.javasdk.agent.SessionMemoryEntity
Consistent read (not ReadOnlyEffect).
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
Returns the session history for the model.
GetHistoryCmd() - Constructor for record class akka.javasdk.agent.SessionMemoryEntity.GetHistoryCmd
 
GetHistoryCmd(List<MemoryFilter>) - Constructor for record class akka.javasdk.agent.SessionMemoryEntity.GetHistoryCmd
 
GetHistoryCmd(Optional<Integer>) - Constructor for record class akka.javasdk.agent.SessionMemoryEntity.GetHistoryCmd
 
GetHistoryCmd(Optional<Integer>, List<MemoryFilter>) - 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.
getLast(String) - Method in interface akka.javasdk.Metadata
Get the last string value for the given key, if found.
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.
getMetadata() - Method in class akka.javasdk.eventsourcedentity.EventWithMetadata
 
getMetadata(String) - Method in interface akka.javasdk.objectstorage.ObjectStorage
Retrieve only the metadata for an object without downloading its content, or Optional.empty() if no object exists for the given key.
getMetadataAsync(String) - Method in interface akka.javasdk.objectstorage.ObjectStorage
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
 
getState() - Method in class akka.javasdk.agent.task.TaskEntity
 
getState() - Method in interface akka.javasdk.client.AutonomousAgentClient
Get the current state of this agent instance.
getState() - Method in class akka.javasdk.impl.agent.task.BacklogEntity
Get the current state of the backlog.
getStateAsync() - Method in interface akka.javasdk.client.AutonomousAgentClient
getStreamAsync(String) - Method in interface akka.javasdk.objectstorage.ObjectStorage
Retrieve an object as a streaming source, or Optional.empty() if no object exists for the given key.
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.
getTokenUsage() - Method in class akka.javasdk.agent.SessionMemoryEntity
Consistent read (not ReadOnlyEffect).
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.
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, Duration, Duration, int) - Constructor for record class akka.javasdk.agent.ModelProvider.GoogleAIGemini
Deprecated, for removal: This API element is subject to removal in a future version.
Use constructor with baseUrl parameter, or the static factory method and with methods.
GoogleAIGemini(String, String, Double, Double, int, Duration, Duration, int, String, Optional<Integer>, String, String, Boolean, List<HttpHeader>) - 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
Guardrail - Interface in akka.javasdk.agent
Guardrails can protect against harmful inputs and outputs to/from model and tool calls.
Guardrail.GuardrailException - Exception Class in akka.javasdk.agent
Thrown when the text didn't pass the evaluation criteria, and report-only is true.
Guardrail.Result - Record Class in akka.javasdk.agent
The result of the guardrail evaluation.
GuardrailContext - Interface in akka.javasdk.agent
Context information available to a guardrail constructor.
GuardrailException(String) - Constructor for exception class akka.javasdk.agent.Guardrail.GuardrailException
 

H

HallucinationEvaluator - Class in akka.javasdk.agent.evaluator
An agent that acts as an LLM judge to evaluate whether an output contains information not available in the reference text given an input question.
HallucinationEvaluator(ComponentClient, Config) - Constructor for class akka.javasdk.agent.evaluator.HallucinationEvaluator
 
HallucinationEvaluator.EvaluationRequest - Record Class in akka.javasdk.agent.evaluator
 
HallucinationEvaluator.Result - Record Class in akka.javasdk.agent.evaluator
 
handler() - Method in record class akka.javasdk.workflow.Workflow.CommandHandler.NoArgCommandHandler
Returns the value of the handler record component.
handler() - Method in record class akka.javasdk.workflow.Workflow.CommandHandler.OneArgCommandHandler
Returns the value of the handler record component.
handler() - Method in record class akka.javasdk.workflow.Workflow.StepHandler.NoArgStepHandler
Returns the value of the handler record component.
handler() - Method in record class akka.javasdk.workflow.Workflow.StepHandler.OneArgStepHandler
Returns the value of the handler record component.
HandoffReceived(String, String, String) - Constructor for record class akka.javasdk.agent.autonomous.Notification.HandoffReceived
Creates an instance of a HandoffReceived record class.
HandoffStarted(String, String, String, String) - Constructor for record class akka.javasdk.agent.autonomous.Notification.HandoffStarted
Creates an instance of a HandoffStarted record class.
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.Agent.AgentReply
Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.agent.Agent.TokenUsage
Returns a hash code value for this object.
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.autonomous.AutonomousAgent.TokenUsage
Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.agent.autonomous.Notification.Activated
Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.agent.autonomous.Notification.BacklogAccessGranted
Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.agent.autonomous.Notification.BacklogAssigned
Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.agent.autonomous.Notification.BacklogClosed
Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.agent.autonomous.Notification.BacklogTaskClaimed
Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.agent.autonomous.Notification.ContactAdded
Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.agent.autonomous.Notification.ConversationCreated
Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.agent.autonomous.Notification.ConversationEnded
Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.agent.autonomous.Notification.ConversationJoined
Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.agent.autonomous.Notification.ConversationParticipantReady
Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.agent.autonomous.Notification.ConversationParticipantSetupFailed
Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.agent.autonomous.Notification.ConversationTurnReceived
Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.agent.autonomous.Notification.Deactivated
Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.agent.autonomous.Notification.DelegationResolved
Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.agent.autonomous.Notification.DelegationStarted
Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.agent.autonomous.Notification.DependencyResolved
Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.agent.autonomous.Notification.HandoffReceived
Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.agent.autonomous.Notification.HandoffStarted
Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.agent.autonomous.Notification.IterationCompleted
Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.agent.autonomous.Notification.IterationFailed
Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.agent.autonomous.Notification.IterationStarted
Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.agent.autonomous.Notification.MessageReceived
Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.agent.autonomous.Notification.ParticipantTurnSubmitted
Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.agent.autonomous.Notification.RepeatedIterationFailure
Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.agent.autonomous.Notification.Resumed
Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.agent.autonomous.Notification.Stopped
Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.agent.autonomous.Notification.Suspended
Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.agent.autonomous.Notification.TaskApproachingMaxIterations
Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.agent.autonomous.Notification.TaskAssigned
Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.agent.autonomous.Notification.TaskCancelled
Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.agent.autonomous.Notification.TaskCompleted
Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.agent.autonomous.Notification.TaskDependencyStuck
Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.agent.autonomous.Notification.TaskDependencyWait
Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.agent.autonomous.Notification.TaskFailed
Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.agent.autonomous.Notification.TaskResultRejected
Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.agent.autonomous.Notification.TaskStarted
Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.agent.autonomous.Notification.TaskStruggleDetected
Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.agent.autonomous.Notification.TeamCreated
Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.agent.autonomous.Notification.TeamDisbanded
Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.agent.autonomous.Notification.TeamJoined
Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.agent.autonomous.Notification.TeamMemberReady
Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.agent.autonomous.Notification.TeamMemberSetupFailed
Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.agent.autonomous.Notification.TeamMemberStopped
Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.agent.autonomous.Notification.WorkerTaskCompleted
Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.agent.autonomous.Notification.WorkerTaskReceived
Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.agent.ContentLoader.LoadedContent
Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.agent.evaluator.HallucinationEvaluator.EvaluationRequest
Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.agent.evaluator.HallucinationEvaluator.Result
Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.agent.evaluator.SummarizationEvaluator.EvaluationRequest
Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.agent.evaluator.SummarizationEvaluator.Result
Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.agent.evaluator.ToxicityEvaluator.Result
Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.agent.Guardrail.Result
Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.agent.ImageLoader.LoadedImage
Deprecated.
Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.agent.MemoryFilter.Exclude
Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.agent.MemoryFilter.Include
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.MessageContent.ImageMessageContent
Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.agent.MessageContent.ImageUrlMessageContent
Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.agent.MessageContent.PdfMessageContent
Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.agent.MessageContent.PdfUrlMessageContent
Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.agent.MessageContent.TextMessageContent
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.AzureOpenAi
Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.agent.ModelProvider.Bedrock
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.MistralAi
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.ModelProvider.VertexAi
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.SessionHistoryResult.Loaded
Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.agent.SessionHistoryResult.Truncated
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.AddMultimodalInteractionCmd
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.MultimodalUserMessageAdded
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.MessageContent.ImageUriMessageContent
Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.agent.SessionMessage.MessageContent.PdfUriMessageContent
Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.agent.SessionMessage.MessageContent.TextMessageContent
Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.agent.SessionMessage.MultimodalUserMessage
Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.agent.SessionMessage.TokenUsage
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.agent.task.TaskAttachment
Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.agent.task.TaskEntity.CreateRequest
Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.agent.task.TaskEntity.ReassignRequest
Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.agent.task.TaskEntity.RejectResultRequest
Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.agent.task.TaskEvent.TaskAssigned
Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.agent.task.TaskEvent.TaskCancelled
Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.agent.task.TaskEvent.TaskCompleted
Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.agent.task.TaskEvent.TaskCreated
Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.agent.task.TaskEvent.TaskFailed
Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.agent.task.TaskEvent.TaskReassigned
Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.agent.task.TaskEvent.TaskResultRejected
Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.agent.task.TaskEvent.TaskStarted
Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.agent.task.TaskKey
Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.agent.task.TaskNotification.Cancelled
Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.agent.task.TaskNotification.Completed
Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.agent.task.TaskNotification.Failed
Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.agent.task.TaskNotification.ResultRejected
Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.agent.task.TaskRule.Result.Accepted
Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.agent.task.TaskRule.Result.Rejected
Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.agent.task.TaskSnapshot
Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.agent.task.TaskState
Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.agent.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.DataMessageContentImpl.Image
Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.impl.agent.DataMessageContentImpl.Pdf
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 record class akka.javasdk.impl.agent.task.BacklogEntity.ClaimRequest
Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.impl.agent.task.BacklogEntity.TransferRequest
Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.impl.agent.task.BacklogEvent.BacklogClosed
Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.impl.agent.task.BacklogEvent.BacklogCreated
Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.impl.agent.task.BacklogEvent.TaskAdded
Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.impl.agent.task.BacklogEvent.TaskClaimed
Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.impl.agent.task.BacklogEvent.TaskReleased
Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.impl.agent.task.BacklogEvent.TaskTransferred
Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.impl.agent.task.BacklogEvent.UnclaimedCancelled
Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.impl.agent.task.BacklogNotification.BacklogClosed
Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.impl.agent.task.BacklogNotification.BacklogCreated
Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.impl.agent.task.BacklogNotification.TaskAdded
Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.impl.agent.task.BacklogNotification.TaskClaimed
Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.impl.agent.task.BacklogNotification.TaskReleased
Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.impl.agent.task.BacklogNotification.TaskTransferred
Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.impl.agent.task.BacklogNotification.UnclaimedCancelled
Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.impl.agent.task.BacklogState.Entry
Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.impl.agent.task.BacklogState
Returns a hash code value for this object.
hashCode() - Method in class akka.javasdk.Principal.LocalService
 
hashCode() - Method in record class akka.javasdk.view.EntryWithMetadata
Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.workflow.Workflow.CommandHandler.NoArgCommandHandler
Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.workflow.Workflow.CommandHandler.OneArgCommandHandler
Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.workflow.Workflow.PauseSettings
Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.workflow.Workflow.PauseSettingsBuilder
Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.workflow.Workflow.RecoverStrategy
Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.workflow.Workflow.RecoverStrategy.MaxRetries
Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.workflow.Workflow.RecoverStrategy.RecoveryInput
Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.workflow.Workflow.StepHandler.NoArgStepHandler
Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.workflow.Workflow.StepHandler.OneArgStepHandler
Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.workflow.Workflow.StepMethod
Returns a hash code value for this object.
hashCode() - Method in record class akka.javasdk.workflow.Workflow.StepSettings
Returns a hash code value for this object.
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
 
HIGH - Enum constant in enum class akka.javasdk.agent.MessageContent.ImageMessageContent.DetailLevel
Higher resolution processing, more detailed analysis but uses more tokens.
history() - Method in record class akka.javasdk.agent.SessionHistoryResult.Loaded
Returns the value of the history record component.
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, Duration, Duration, int, boolean, List<HttpHeader>) - 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() - Method in record class akka.javasdk.agent.task.TaskKey
Returns the value of the id record component.
id() - Element in annotation interface akka.javasdk.annotations.Component
The unique identifier for this component (mandatory).
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.
ids() - Method in record class akka.javasdk.agent.MemoryFilter.Exclude
Returns the value of the ids record component.
ids() - Method in record class akka.javasdk.agent.MemoryFilter.Include
Returns the value of the ids record component.
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.
Image(byte[], Optional<String>, MessageContent.ImageMessageContent.DetailLevel) - Constructor for record class akka.javasdk.impl.agent.DataMessageContentImpl.Image
Creates an instance of a Image record class.
imageLoader(ImageLoader) - Method in interface akka.javasdk.agent.Agent.Effect.Builder
Deprecated, for removal: This API element is subject to removal in a future version.
use contentLoader
imageLoader(ImageLoader) - Method in interface akka.javasdk.agent.Agent.StreamEffect.Builder
Deprecated, for removal: This API element is subject to removal in a future version.
use contentLoader
ImageLoader - Interface in akka.javasdk.agent
Deprecated, for removal: This API element is subject to removal in a future version.
ImageLoader.LoadedImage - Record Class in akka.javasdk.agent
Deprecated.
Represents a loaded image with its binary data and MIME type.
ImageMessageContent() - Constructor for record class akka.javasdk.agent.MessageContent.ImageMessageContent
Creates an instance of a ImageMessageContent record class.
ImageUriMessageContent(String, MessageContent.ImageMessageContent.DetailLevel, Optional<String>) - Constructor for record class akka.javasdk.agent.SessionMessage.MessageContent.ImageUriMessageContent
Creates an instance of a ImageUriMessageContent record class.
ImageUrlMessageContent(URI, MessageContent.ImageMessageContent.DetailLevel) - Constructor for record class akka.javasdk.agent.MessageContent.ImageUrlMessageContent
Image content within a user message, referenced by URI.
ImageUrlMessageContent(URI, MessageContent.ImageMessageContent.DetailLevel, Optional<String>) - Constructor for record class akka.javasdk.agent.MessageContent.ImageUrlMessageContent
Creates an instance of a ImageUrlMessageContent record class.
ImageUrlMessageContent(URL, MessageContent.ImageMessageContent.DetailLevel) - Constructor for record class akka.javasdk.agent.MessageContent.ImageUrlMessageContent
Deprecated, for removal: This API element is subject to removal in a future version.
ImageUrlMessageContent(URL, MessageContent.ImageMessageContent.DetailLevel, Optional<String>) - Constructor for record class akka.javasdk.agent.MessageContent.ImageUrlMessageContent
Deprecated, for removal: This API element is subject to removal in a future version.
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
IN_PROGRESS - Enum constant in enum class akka.javasdk.agent.task.TaskStatus
An agent is actively working on it.
Include(Set<String>, Set<String>) - Constructor for record class akka.javasdk.agent.MemoryFilter.Include
Creates an instance of a Include record class.
includeFromAgentId(String) - Static method in interface akka.javasdk.agent.MemoryFilter
Creates a filter supplier that includes only messages from the specified agent component id.
includeFromAgentId(String) - Method in interface akka.javasdk.agent.MemoryFilter.MemoryFilterSupplier
Adds a filter to include only messages from the specified agent component id.
includeFromAgentIds(Set<String>) - Static method in interface akka.javasdk.agent.MemoryFilter
Creates a filter supplier that includes only messages from the specified agent component ids.
includeFromAgentIds(Set<String>) - Method in interface akka.javasdk.agent.MemoryFilter.MemoryFilterSupplier
Adds a filter to include only messages from the specified agent component ids.
includeFromAgentRole(String) - Static method in interface akka.javasdk.agent.MemoryFilter
Creates a filter supplier that includes only messages from agents with the specified role.
includeFromAgentRole(String) - Method in interface akka.javasdk.agent.MemoryFilter.MemoryFilterSupplier
Adds a filter to include only messages from agents with the specified role.
includeFromAgentRoles(Set<String>) - Static method in interface akka.javasdk.agent.MemoryFilter
Creates a filter supplier that includes only messages from agents with the specified roles.
includeFromAgentRoles(Set<String>) - Method in interface akka.javasdk.agent.MemoryFilter.MemoryFilterSupplier
Adds a filter to include only messages from agents with the specified roles.
includeRegion(String) - Method in interface akka.javasdk.eventsourcedentity.ReplicationFilter.Builder
Adds a region to this replication filter.
includeRegion(String) - Static method in interface akka.javasdk.eventsourcedentity.ReplicationFilter
Creates a replication filter that includes the specified region.
includeRegion(String) - Method in interface akka.javasdk.keyvalueentity.ReplicationFilter.Builder
Adds a region to this replication filter.
includeRegion(String) - Static method in interface akka.javasdk.keyvalueentity.ReplicationFilter
Creates a replication filter that includes the specified region.
includeRegions(Set<String>) - Method in interface akka.javasdk.eventsourcedentity.ReplicationFilter.Builder
Adds multiple regions to this replication filter.
includeRegions(Set<String>) - Static method in interface akka.javasdk.eventsourcedentity.ReplicationFilter
Creates a replication filter that includes the specified regions.
includeRegions(Set<String>) - Method in interface akka.javasdk.keyvalueentity.ReplicationFilter.Builder
Adds multiple regions to this replication filter.
includeRegions(Set<String>) - Static method in interface akka.javasdk.keyvalueentity.ReplicationFilter
Creates a replication filter that includes the specified regions.
init(String) - Method in class akka.javasdk.agent.PromptTemplate
Initialize the prompt template.
input() - Method in record class akka.javasdk.workflow.Workflow.CommandHandler.OneArgCommandHandler
Returns the value of the input record component.
input() - Method in record class akka.javasdk.workflow.Workflow.StepHandler.OneArgStepHandler
Returns the value of the input record component.
inputSchema() - Element in annotation interface akka.javasdk.annotations.mcp.McpTool
Normally, the schema is inferred from the input parameters of the tool method.
inputTokens() - Method in record class akka.javasdk.agent.Agent.TokenUsage
Returns the value of the inputTokens record component.
inputTokens() - Method in record class akka.javasdk.agent.autonomous.AutonomousAgent.TokenUsage
Returns the value of the inputTokens record component.
inputTokens() - Method in record class akka.javasdk.agent.SessionMessage.TokenUsage
Returns the value of the inputTokens record component.
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() - Method in class akka.javasdk.agent.autonomous.AgentState
The agent's current instructions.
instructions() - Method in class akka.javasdk.agent.task.Task
Per-request instructions, or empty string if none were provided.
instructions() - Method in record class akka.javasdk.agent.task.TaskEntity.CreateRequest
Returns the value of the instructions record component.
instructions() - Method in record class akka.javasdk.agent.task.TaskEvent.TaskCreated
Returns the value of the instructions record component.
instructions() - Method in record class akka.javasdk.agent.task.TaskSnapshot
Returns the value of the instructions record component.
instructions() - Method in record class akka.javasdk.agent.task.TaskState
Returns the value of the instructions record component.
instructions() - Element in annotation interface akka.javasdk.annotations.mcp.McpEndpoint
 
instructions(String) - Method in interface akka.javasdk.agent.autonomous.AgentDefinition
Optional internal, LLM-facing instructions appended to the system message.
instructions(String) - Method in interface akka.javasdk.agent.autonomous.AgentSetup
Override the agent's instructions for this instance.
instructions(String) - Method in class akka.javasdk.agent.task.Task
Return a new task with per-request instructions attached.
instructions(String) - Method in class akka.javasdk.agent.task.TaskTemplate
Override the template with free-form instructions, returning a submittable Task.
instructionTemplate() - Method in class akka.javasdk.agent.task.TaskTemplate
The instruction template string with {paramName} placeholders.
instructionTemplate(String) - Method in class akka.javasdk.agent.task.TaskTemplate
Set the instruction template with {paramName} placeholders.
interceptor - Variable in class akka.javasdk.agent.MemoryProvider.InterceptedMemoryProvider
 
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.AgentInvokeOnlyMethodRef
Execute the call and block until the response is available.
invoke() - Method in interface akka.javasdk.client.AgentMethodRef
 
invoke() - Method in interface akka.javasdk.client.AgentReplyInvokeOnlyMethodRef
Execute the call and block until the response is available.
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.AgentInvokeOnlyMethodRef1
Execute the call and block until the response is available.
invoke(A1) - Method in interface akka.javasdk.client.AgentMethodRef1
 
invoke(A1) - Method in interface akka.javasdk.client.AgentReplyInvokeOnlyMethodRef1
Execute the call and block until the response is available.
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
 
invoke(Object, Object...) - Method in record class akka.javasdk.workflow.Workflow.StepMethod
 
invokeAsync() - Method in interface akka.javasdk.client.AgentInvokeOnlyMethodRef
Execute the call asynchronously.
invokeAsync() - Method in interface akka.javasdk.client.AgentMethodRef
 
invokeAsync() - Method in interface akka.javasdk.client.AgentReplyInvokeOnlyMethodRef
Execute the call asynchronously.
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.AgentInvokeOnlyMethodRef1
Execute the call asynchronously.
invokeAsync(A1) - Method in interface akka.javasdk.client.AgentMethodRef1
 
invokeAsync(A1) - Method in interface akka.javasdk.client.AgentReplyInvokeOnlyMethodRef1
Execute the call asynchronously.
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.
isClaimed(String) - Method in record class akka.javasdk.impl.agent.task.BacklogState
 
isCloudEvent() - Method in interface akka.javasdk.Metadata
Whether this metadata is also a CloudEvent.
isCreated() - Method in record class akka.javasdk.impl.agent.task.BacklogState
 
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
 
isEmpty() - Method in record class akka.javasdk.impl.agent.task.BacklogState
 
isEmpty() - Method in interface akka.javasdk.Metadata
 
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.
isTextOnly() - Method in record class akka.javasdk.agent.UserMessage
 
iteration() - Method in record class akka.javasdk.agent.autonomous.Notification.TaskApproachingMaxIterations
Returns the value of the iteration record component.
iteration() - Method in record class akka.javasdk.agent.autonomous.Notification.TaskStruggleDetected
Returns the value of the iteration record component.
IterationCompleted(AutonomousAgent.TokenUsage) - Constructor for record class akka.javasdk.agent.autonomous.Notification.IterationCompleted
Creates an instance of a IterationCompleted record class.
IterationFailed(String, Optional<String>, Optional<Integer>) - Constructor for record class akka.javasdk.agent.autonomous.Notification.IterationFailed
Creates an instance of a IterationFailed record class.
iterationNumber() - Method in record class akka.javasdk.agent.autonomous.Notification.IterationFailed
Returns the value of the iterationNumber record component.
iterationsFailed() - Method in record class akka.javasdk.agent.autonomous.Notification.RepeatedIterationFailure
Returns the value of the iterationsFailed record component.
IterationStarted() - Constructor for record class akka.javasdk.agent.autonomous.Notification.IterationStarted
Creates an instance of a IterationStarted record class.
iterationsUsed() - Method in record class akka.javasdk.agent.autonomous.Notification.ParticipantTurnSubmitted
Returns the value of the iterationsUsed record component.

J

javaMethod() - Method in record class akka.javasdk.workflow.Workflow.StepMethod
Returns the value of the javaMethod record component.
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

key - Variable in class akka.javasdk.objectstorage.ObjectMetadata
The object key within the bucket.
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

lambda() - Method in record class akka.javasdk.workflow.Workflow.RecoverStrategy.RecoveryInput
Returns the value of the lambda record component.
lastModified - Variable in class akka.javasdk.objectstorage.ObjectMetadata
Time at which the object was last modified.
lastNMessages() - Method in record class akka.javasdk.agent.SessionMemoryEntity.GetHistoryCmd
Returns the value of the lastNMessages record component.
lastReason() - Method in record class akka.javasdk.agent.autonomous.Notification.RepeatedIterationFailure
Returns the value of the lastReason record component.
lastSeenSseEventId() - Method in interface akka.javasdk.http.RequestContext
 
lastUpdated() - Method in record class akka.javasdk.view.EntryWithMetadata
 
leadComponentId() - Method in record class akka.javasdk.agent.autonomous.Notification.TeamJoined
Returns the value of the leadComponentId record component.
leadInstanceId() - Method in record class akka.javasdk.agent.autonomous.Notification.TeamJoined
Returns the value of the leadInstanceId 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, List<MemoryFilter>) - 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.
listObjects() - Method in interface akka.javasdk.objectstorage.ObjectStorage
List all objects in the bucket.
listObjects(String) - Method in interface akka.javasdk.objectstorage.ObjectStorage
List all objects whose keys start with prefix.
listObjectsStream() - Method in interface akka.javasdk.objectstorage.ObjectStorage
List all objects in the bucket.
listObjectsStream(String) - Method in interface akka.javasdk.objectstorage.ObjectStorage
List all objects whose keys start with prefix.
load(MessageContent.LoadableMessageContent) - Method in interface akka.javasdk.agent.ContentLoader
Loads content from the given loadable message content.
load(MessageContent.LoadableMessageContent) - Method in interface akka.javasdk.agent.ImageLoader
Deprecated.
 
load(URI, MessageContent.ImageMessageContent.DetailLevel, Optional<String>) - Method in interface akka.javasdk.agent.ImageLoader
Deprecated.
Loads an image from the given URI.
Loaded(SessionHistory) - Constructor for record class akka.javasdk.agent.SessionHistoryResult.Loaded
Creates an instance of a Loaded record class.
LoadedContent(byte[], Optional<String>) - Constructor for record class akka.javasdk.agent.ContentLoader.LoadedContent
Creates an instance of a LoadedContent record class.
LoadedImage(byte[], Optional<String>) - Constructor for record class akka.javasdk.agent.ImageLoader.LoadedImage
Deprecated.
Creates an instance of a LoadedImage 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, List<HttpHeader>) - 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
location() - Method in record class akka.javasdk.agent.ModelProvider.VertexAi
Returns the value of the location record component.
LOW - Enum constant in enum class akka.javasdk.agent.MessageContent.ImageMessageContent.DetailLevel
Lower resolution processing, faster and uses fewer tokens.

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.
maxCompletionTokens() - Method in record class akka.javasdk.agent.ModelProvider.AzureOpenAi
Returns the value of the maxCompletionTokens record component.
maxCompletionTokens() - Method in record class akka.javasdk.agent.ModelProvider.OpenAi
Returns the value of the maxCompletionTokens record component.
maxConcurrentConversations(int) - Method in interface akka.javasdk.agent.autonomous.capability.Moderation
Maximum number of concurrent conversations for this group.
maxConcurrentTeams(int) - Method in interface akka.javasdk.agent.autonomous.capability.TeamLeadership
Maximum number of teams this lead can run concurrently.
maxInstances(int) - Method in interface akka.javasdk.agent.autonomous.capability.TeamLeadership.TeamMember
Maximum number of instances of this member type that can be added to the team.
maxIterations() - Method in record class akka.javasdk.agent.autonomous.Notification.TaskApproachingMaxIterations
Returns the value of the maxIterations record component.
maxIterations() - Method in record class akka.javasdk.agent.autonomous.Notification.TaskStruggleDetected
Returns the value of the maxIterations record component.
maxIterationsPerTask(int) - Method in class akka.javasdk.agent.autonomous.capability.TaskAcceptance
Maximum iterations before the agent fails the current task.
maxIterationsPerTurn(int) - Method in interface akka.javasdk.agent.autonomous.capability.Moderation
Maximum LLM iterations a participant gets per turn before auto-submitting.
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.Bedrock
Returns the value of the maxOutputTokens record component.
maxOutputTokens() - Method in record class akka.javasdk.agent.ModelProvider.GoogleAIGemini
Returns the value of the maxOutputTokens record component.
maxOutputTokens() - Method in record class akka.javasdk.agent.ModelProvider.VertexAi
Returns the value of the maxOutputTokens record component.
maxParallelWorkers(int) - Method in interface akka.javasdk.agent.autonomous.capability.Delegation
Maximum number of worker agents that can execute delegated subtasks concurrently.
maxRetries() - Method in record class akka.javasdk.agent.ModelProvider.Anthropic
Returns the value of the maxRetries record component.
maxRetries() - Method in record class akka.javasdk.agent.ModelProvider.AzureOpenAi
Returns the value of the maxRetries record component.
maxRetries() - Method in record class akka.javasdk.agent.ModelProvider.Bedrock
Returns the value of the maxRetries record component.
maxRetries() - Method in record class akka.javasdk.agent.ModelProvider.GoogleAIGemini
Returns the value of the maxRetries record component.
maxRetries() - Method in record class akka.javasdk.agent.ModelProvider.HuggingFace
Returns the value of the maxRetries record component.
maxRetries() - Method in record class akka.javasdk.agent.ModelProvider.MistralAi
Returns the value of the maxRetries record component.
maxRetries() - Method in record class akka.javasdk.agent.ModelProvider.Ollama
Returns the value of the maxRetries record component.
maxRetries() - Method in record class akka.javasdk.agent.ModelProvider.OpenAi
Returns the value of the maxRetries record component.
maxRetries() - Method in record class akka.javasdk.agent.ModelProvider.VertexAi
Returns the value of the maxRetries record component.
maxRetries() - Method in record class akka.javasdk.workflow.Workflow.RecoverStrategy
Returns the value of the maxRetries record component.
maxRetries() - Method in record class akka.javasdk.workflow.Workflow.RecoverStrategy.MaxRetries
Returns the value of the maxRetries record component.
maxRetries() - Method in record class akka.javasdk.workflow.Workflow.RecoverStrategy.RecoveryInput
Returns the value of the maxRetries record component.
maxRetries(int) - Static method in record class akka.javasdk.workflow.Workflow.RecoverStrategy
Set the number of retries for a failed step, maxRetries equals 0 means that the step won't retry in case of failure.
MaxRetries(int) - Constructor for record class akka.javasdk.workflow.Workflow.RecoverStrategy.MaxRetries
Creates an instance of a MaxRetries record class.
maxRounds(int) - Method in interface akka.javasdk.agent.autonomous.capability.Moderation
Maximum number of conversation rounds.
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.AzureOpenAi
Returns the value of the maxTokens record component.
maxTokens() - Method in record class akka.javasdk.agent.ModelProvider.Bedrock
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.MistralAi
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...) - Method in interface akka.javasdk.agent.autonomous.AgentDefinition
Remote MCP tool endpoints available to the agent.
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.
mediaResolution() - Method in record class akka.javasdk.agent.ModelProvider.GoogleAIGemini
Returns the value of the mediaResolution record component.
mediaResolutionPerPartEnabled() - Method in record class akka.javasdk.agent.ModelProvider.GoogleAIGemini
Returns the value of the mediaResolutionPerPartEnabled record component.
MEDIUM - Enum constant in enum class akka.javasdk.agent.MessageContent.ImageMessageContent.DetailLevel
Medium resolution processing, balance between detail, cost, and latency.
memberComponentId() - Method in record class akka.javasdk.agent.autonomous.Notification.TeamMemberReady
Returns the value of the memberComponentId record component.
memberComponentId() - Method in record class akka.javasdk.agent.autonomous.Notification.TeamMemberSetupFailed
Returns the value of the memberComponentId record component.
memberComponentId() - Method in record class akka.javasdk.agent.autonomous.Notification.TeamMemberStopped
Returns the value of the memberComponentId record component.
memberComponentIds() - Method in record class akka.javasdk.agent.autonomous.Notification.TeamCreated
Returns the value of the memberComponentIds record component.
memberInstanceId() - Method in record class akka.javasdk.agent.autonomous.Notification.TeamMemberReady
Returns the value of the memberInstanceId record component.
memberInstanceId() - Method in record class akka.javasdk.agent.autonomous.Notification.TeamMemberSetupFailed
Returns the value of the memberInstanceId record component.
memberInstanceId() - Method in record class akka.javasdk.agent.autonomous.Notification.TeamMemberStopped
Returns the value of the memberInstanceId record component.
memberInstanceIds() - Method in record class akka.javasdk.agent.autonomous.Notification.TeamCreated
Returns the value of the memberInstanceIds record component.
memory(MemoryProvider) - Method in interface akka.javasdk.agent.Agent.Effect.Builder
 
memory(MemoryProvider) - Method in interface akka.javasdk.agent.Agent.StreamEffect.Builder
 
MemoryFilter - Interface in akka.javasdk.agent
Filters for controlling which messages are included when retrieving session history from memory.
MemoryFilter.Exclude - Record Class in akka.javasdk.agent
Filter that excludes messages from agents with the specified component IDs or roles.
MemoryFilter.Include - Record Class in akka.javasdk.agent
Filter that includes messages from agents with the specified component IDs or roles.
MemoryFilter.MemoryFilterSupplier - Interface in akka.javasdk.agent
A fluent builder for composing multiple memory filters.
memoryFilters() - Method in record class akka.javasdk.agent.SessionMemoryEntity.GetHistoryCmd
Returns the value of the memoryFilters record component.
memoryFilters() - Method in record class akka.javasdk.impl.agent.SessionMemoryClient.MemorySettings
Returns the value of the memoryFilters record component.
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.InterceptedMemoryProvider - Class in akka.javasdk.agent
Memory provider that wraps another MemoryProvider with a SessionMemoryInterceptor.
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>, List<MemoryFilter>) - Constructor for record class akka.javasdk.impl.agent.SessionMemoryClient.MemorySettings
Creates an instance of a MemorySettings record class.
merge(MemoryFilter.Exclude) - Method in record class akka.javasdk.agent.MemoryFilter.Exclude
 
merge(MemoryFilter.Include) - Method in record class akka.javasdk.agent.MemoryFilter.Include
 
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.
MessageContent - Interface in akka.javasdk.agent
Represents a piece of content within a multimodal message to an AI model.
MessageContent.DataMessageContent - Interface in akka.javasdk.agent
Inline content already loaded as bytes.
MessageContent.ImageDataMessageContent - Interface in akka.javasdk.agent
Image content carried as inline bytes.
MessageContent.ImageMessageContent - Record Class in akka.javasdk.agent
Factory methods for creating image message content.
MessageContent.ImageMessageContent.DetailLevel - Enum Class in akka.javasdk.agent
Controls the level of detail used when processing images.
MessageContent.ImageUrlMessageContent - Record Class in akka.javasdk.agent
Image content within a user message, referenced by URI.
MessageContent.LoadableMessageContent - Interface in akka.javasdk.agent
 
MessageContent.PdfDataMessageContent - Interface in akka.javasdk.agent
PDF content carried as inline bytes.
MessageContent.PdfMessageContent - Record Class in akka.javasdk.agent
Factory methods for creating PDF message content.
MessageContent.PdfUrlMessageContent - Record Class in akka.javasdk.agent
PDF content within a user message, referenced by URI.
MessageContent.TextMessageContent - Record Class in akka.javasdk.agent
Text content within a user message.
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.
MessageReceived(String, String, String) - Constructor for record class akka.javasdk.agent.autonomous.Notification.MessageReceived
Creates an instance of a MessageReceived record class.
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.AddMultimodalInteractionCmd
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 - Variable in class akka.javasdk.objectstorage.StorageObject
Metadata for the object.
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() - Method in record class akka.javasdk.view.EntryWithMetadata
Returns the value of the metadata record component.
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 command handler method reference, 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 command handler method reference, e.g.
methodName() - Method in record class akka.javasdk.workflow.Workflow.StepMethod
Returns the value of the methodName record component.
Migration - Annotation Interface in akka.javasdk.annotations
Annotation to assign a @JsonMigration implementation for a given class.
mimeType() - Method in record class akka.javasdk.agent.ContentLoader.LoadedContent
Returns the value of the mimeType record component.
mimeType() - Method in record class akka.javasdk.agent.ImageLoader.LoadedImage
Deprecated.
Returns the value of the mimeType record component.
mimeType() - Method in interface akka.javasdk.agent.MessageContent.DataMessageContent
 
mimeType() - Method in record class akka.javasdk.agent.MessageContent.ImageUrlMessageContent
Returns the value of the mimeType record component.
mimeType() - Method in record class akka.javasdk.agent.SessionMessage.MessageContent.ImageUriMessageContent
Returns the value of the mimeType record component.
mimeType() - Method in record class akka.javasdk.agent.task.TaskAttachment
Returns the value of the mimeType record component.
mimeType() - Element in annotation interface akka.javasdk.annotations.mcp.McpResource
 
mimeType() - Method in record class akka.javasdk.impl.agent.DataMessageContentImpl.Image
Returns the value of the mimeType record component.
mimeType() - Method in record class akka.javasdk.impl.agent.DataMessageContentImpl.Pdf
Returns the value of the mimeType record component.
mistralAi() - Static method in interface akka.javasdk.agent.ModelProvider
Settings for the Mistral AI Large Language Model provider.
MistralAi(String, String, String, double, double, int, boolean, int, double, double, List<String>, boolean, Duration, Duration, int, List<HttpHeader>) - Constructor for record class akka.javasdk.agent.ModelProvider.MistralAi
Creates an instance of a MistralAi record class.
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.Bedrock
Returns the value of the modelId record component.
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 interface akka.javasdk.agent.ModelProvider.Custom
Override this method to provide a meaningful model name for your custom provider.
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.MistralAi
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.
modelName() - Method in record class akka.javasdk.agent.ModelProvider.VertexAi
Returns the value of the modelName record component.
modelProvider() - Method in class akka.javasdk.agent.evaluator.HallucinationEvaluator
 
modelProvider() - Method in class akka.javasdk.agent.evaluator.SummarizationEvaluator
 
modelProvider() - Method in class akka.javasdk.agent.evaluator.ToxicityEvaluator
 
modelProvider(ModelProvider) - Method in interface akka.javasdk.agent.autonomous.AgentDefinition
The LLM model provider for this agent.
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.AzureOpenAi - Record Class in akka.javasdk.agent
Settings for the Azure OpenAI Large Language Model provider.
ModelProvider.Bedrock - Record Class in akka.javasdk.agent
 
ModelProvider.BedrockPromptCachePlacement - Enum Class in akka.javasdk.agent
Placement of the prompt cache point when using Bedrock with supported Claude or Nova models.
ModelProvider.Custom - Interface in akka.javasdk.agent
Custom models can be added by implementing this interface and, and the underlying implementations of dev.langchain4j.model.chat.ChatModel and (optionally) dev.langchain4j.model.chat.StreamingChatModel.
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.MistralAi - Record Class in akka.javasdk.agent
Settings for the Mistral 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.
ModelProvider.VertexAi - Record Class in akka.javasdk.agent
Settings for the Google Cloud Vertex AI 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
 
Moderation - Interface in akka.javasdk.agent.autonomous.capability
Declares that an agent can moderate turn-taking conversations between participant agents.
moderatorComponentId() - Method in record class akka.javasdk.agent.autonomous.Notification.ConversationJoined
Returns the value of the moderatorComponentId record component.
moderatorInstanceId() - Method in record class akka.javasdk.agent.autonomous.Notification.ConversationJoined
Returns the value of the moderatorInstanceId record component.
modifyRequest(Function<HttpRequest, HttpRequest>) - Method in interface akka.javasdk.http.RequestBuilder
Transform the request before sending it.
MultimodalUserMessage(Instant, List<SessionMessage.MessageContent>, String) - Constructor for record class akka.javasdk.agent.SessionMessage.MultimodalUserMessage
Creates an instance of a MultimodalUserMessage record class.
MultimodalUserMessageAdded(Instant, String, List<SessionMessage.MessageContent>, int) - Constructor for record class akka.javasdk.agent.SessionMemoryEntity.Event.MultimodalUserMessageAdded
Creates an instance of a MultimodalUserMessageAdded record class.
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 interface akka.javasdk.agent.GuardrailContext
The name of the guardrail.
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() - Method in class akka.javasdk.agent.task.Task
 
name() - Method in interface akka.javasdk.agent.task.TaskDefinition
The name of this task definition — a stable identifier for the task type.
name() - Method in record class akka.javasdk.agent.task.TaskEntity.CreateRequest
Returns the value of the name record component.
name() - Method in record class akka.javasdk.agent.task.TaskEvent.TaskAssigned
Returns the value of the name record component.
name() - Method in record class akka.javasdk.agent.task.TaskEvent.TaskCancelled
Returns the value of the name record component.
name() - Method in record class akka.javasdk.agent.task.TaskEvent.TaskCompleted
Returns the value of the name record component.
name() - Method in record class akka.javasdk.agent.task.TaskEvent.TaskCreated
Returns the value of the name record component.
name() - Method in record class akka.javasdk.agent.task.TaskEvent.TaskFailed
Returns the value of the name record component.
name() - Method in record class akka.javasdk.agent.task.TaskEvent.TaskReassigned
Returns the value of the name record component.
name() - Method in record class akka.javasdk.agent.task.TaskEvent.TaskResultRejected
Returns the value of the name record component.
name() - Method in record class akka.javasdk.agent.task.TaskEvent.TaskStarted
Returns the value of the name record component.
name() - Method in record class akka.javasdk.agent.task.TaskKey
Returns the value of the name record component.
name() - Method in record class akka.javasdk.agent.task.TaskSnapshot
Returns the value of the name record component.
name() - Method in record class akka.javasdk.agent.task.TaskState
Returns the value of the name record component.
name() - Method in class akka.javasdk.agent.task.TaskTemplate
 
name() - Element in annotation interface akka.javasdk.annotations.Component
A human-readable name for this component (optional).
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 record class akka.javasdk.impl.agent.task.BacklogEvent.BacklogCreated
Returns the value of the name record component.
name() - Method in record class akka.javasdk.impl.agent.task.BacklogNotification.BacklogCreated
Returns the value of the name record component.
name() - Method in record class akka.javasdk.impl.agent.task.BacklogState
Returns the value of the name record component.
name(String) - Static method in class akka.javasdk.agent.task.Task
Define a new task with the given name.
newAssignee() - Method in record class akka.javasdk.agent.task.TaskEntity.ReassignRequest
Returns the value of the newAssignee record component.
newAssignee() - Method in record class akka.javasdk.agent.task.TaskEvent.TaskReassigned
Returns the value of the newAssignee record component.
newBuilder() - Static method in class akka.javasdk.workflow.Workflow.WorkflowSettingsBuilder
 
NoArgCommandHandler(Function<?, Workflow.Effect<Done>>) - Constructor for record class akka.javasdk.workflow.Workflow.CommandHandler.NoArgCommandHandler
Creates an instance of a NoArgCommandHandler record class.
NoArgStepHandler(Function<?, Workflow.StepEffect>) - Constructor for record class akka.javasdk.workflow.Workflow.StepHandler.NoArgStepHandler
Creates an instance of a NoArgStepHandler record class.
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.
Notification - Interface in akka.javasdk.agent.autonomous
Notifications published by the runtime for an autonomous agent instance.
Notification.Activated - Record Class in akka.javasdk.agent.autonomous
Agent activated — transitioned from idle to processing.
Notification.BacklogAccessGranted - Record Class in akka.javasdk.agent.autonomous
Backlog access: this agent has been granted access to a backlog.
Notification.BacklogAssigned - Record Class in akka.javasdk.agent.autonomous
Backlog management: a backlog has been assigned to this agent.
Notification.BacklogClosed - Record Class in akka.javasdk.agent.autonomous
Backlog management: a backlog has been closed.
Notification.BacklogNotification - Interface in akka.javasdk.agent.autonomous
Backlog notifications: backlog assignment/access and task claims.
Notification.BacklogTaskClaimed - Record Class in akka.javasdk.agent.autonomous
Backlog access: this agent claimed a task from a backlog.
Notification.ContactAdded - Record Class in akka.javasdk.agent.autonomous
A new contact was introduced to this agent.
Notification.ConversationCreated - Record Class in akka.javasdk.agent.autonomous
Conversation moderator: a new conversation was created with the given participants.
Notification.ConversationEnded - Record Class in akka.javasdk.agent.autonomous
Conversation moderator: a conversation has ended.
Notification.ConversationJoined - Record Class in akka.javasdk.agent.autonomous
Conversation participant: this agent joined a conversation moderated by the given agent.
Notification.ConversationNotification - Interface in akka.javasdk.agent.autonomous
Conversation notifications: conversation creation, turns, participation.
Notification.ConversationParticipantReady - Record Class in akka.javasdk.agent.autonomous
Conversation moderator: a participant's setup completed and they are ready to take turns.
Notification.ConversationParticipantSetupFailed - Record Class in akka.javasdk.agent.autonomous
Conversation moderator: a participant's setup failed.
Notification.ConversationTurnReceived - Record Class in akka.javasdk.agent.autonomous
Conversation moderator: a turn was received from a participant.
Notification.Deactivated - Record Class in akka.javasdk.agent.autonomous
Agent deactivated — no more work, back to idle.
Notification.DelegationNotification - Interface in akka.javasdk.agent.autonomous
Delegation notifications: orchestrator-side and worker-side of subtask delegation.
Notification.DelegationResolved - Record Class in akka.javasdk.agent.autonomous
Orchestrator side: aggregate resolution of a delegation batch.
Notification.DelegationStarted - Record Class in akka.javasdk.agent.autonomous
Orchestrator side: a batch of subtasks has been dispatched to workers.
Notification.DependencyResolved - Record Class in akka.javasdk.agent.autonomous
A specific dependency for a task has resolved (success or failure).
Notification.HandoffNotification - Interface in akka.javasdk.agent.autonomous
Handoff notifications: source-side and target-side of cross-agent handoffs.
Notification.HandoffReceived - Record Class in akka.javasdk.agent.autonomous
Target side: this agent has received a handed-off task from another agent.
Notification.HandoffStarted - Record Class in akka.javasdk.agent.autonomous
Source side: this agent has handed off a task to another agent.
Notification.IterationCompleted - Record Class in akka.javasdk.agent.autonomous
Agent iteration completed successfully.
Notification.IterationFailed - Record Class in akka.javasdk.agent.autonomous
Agent iteration failed.
Notification.IterationStarted - Record Class in akka.javasdk.agent.autonomous
Agent iteration started — LLM call beginning.
Notification.LifecycleNotification - Interface in akka.javasdk.agent.autonomous
Lifecycle notifications: agent activation, iteration boundaries, pause/resume/stop.
Notification.MessageReceived - Record Class in akka.javasdk.agent.autonomous
A message was received from another agent.
Notification.MessagingNotification - Interface in akka.javasdk.agent.autonomous
Messaging notifications: contact introductions and message delivery.
Notification.ParticipantTurnSubmitted - Record Class in akka.javasdk.agent.autonomous
Conversation participant: this agent submitted its turn after the given number of iterations.
Notification.RepeatedIterationFailure - Record Class in akka.javasdk.agent.autonomous
Derived signal: N consecutive iteration failures in flows not tied to a specific task (pre-task setup, request-based delegation).
Notification.Resumed - Record Class in akka.javasdk.agent.autonomous
Agent resumed.
Notification.Stopped - Record Class in akka.javasdk.agent.autonomous
Agent stopped.
Notification.StruggleNotification - Interface in akka.javasdk.agent.autonomous
Struggle signals: derived notifications for repeated failures, stuck deps, approaching limits.
Notification.Suspended - Record Class in akka.javasdk.agent.autonomous
Agent suspended.
Notification.TaskApproachingMaxIterations - Record Class in akka.javasdk.agent.autonomous
Derived signal: a task is at or beyond a configurable fraction (default 80%) of its max iterations.
Notification.TaskAssigned - Record Class in akka.javasdk.agent.autonomous
A task was assigned (queued) — fires before the model loop begins setup for it.
Notification.TaskCancelled - Record Class in akka.javasdk.agent.autonomous
Task was cancelled by the framework — dependency failure, max iterations, orphan cleanup, etc.
Notification.TaskCompleted - Record Class in akka.javasdk.agent.autonomous
Agent completed a task successfully.
Notification.TaskDependencyStuck - Record Class in akka.javasdk.agent.autonomous
Derived signal: a task waiting on dependencies has been waiting longer than the configured threshold.
Notification.TaskDependencyWait - Record Class in akka.javasdk.agent.autonomous
A task is blocked waiting for one or more dependency tasks to resolve.
Notification.TaskFailed - Record Class in akka.javasdk.agent.autonomous
Agent failed a task via explicit fail_task.
Notification.TaskNotification - Interface in akka.javasdk.agent.autonomous
Task notifications: assignment, start, completion, failure, cancellation, dependencies.
Notification.TaskResultRejected - Record Class in akka.javasdk.agent.autonomous
Agent's task result was rejected by a validation rule.
Notification.TaskStarted - Record Class in akka.javasdk.agent.autonomous
Agent started working on a task.
Notification.TaskStruggleDetected - Record Class in akka.javasdk.agent.autonomous
Derived signal: a task is struggling — N consecutive iteration failures, M consecutive result rejections, or some other impediment captured in Notification.TaskStruggleDetected.reason().
Notification.TeamCreated - Record Class in akka.javasdk.agent.autonomous
Team lead: a new team was formed with the given members.
Notification.TeamDisbanded - Record Class in akka.javasdk.agent.autonomous
Team lead: a team has been disbanded.
Notification.TeamJoined - Record Class in akka.javasdk.agent.autonomous
Team member: this agent joined a team led by the given agent.
Notification.TeamMemberReady - Record Class in akka.javasdk.agent.autonomous
Team lead: a team member's setup chain completed and the member is now active.
Notification.TeamMemberSetupFailed - Record Class in akka.javasdk.agent.autonomous
Team lead: a team member's setup chain failed.
Notification.TeamMemberStopped - Record Class in akka.javasdk.agent.autonomous
Team lead: a team member has stopped.
Notification.TeamNotification - Interface in akka.javasdk.agent.autonomous
Team notifications: team formation, member lifecycle, disbanding.
Notification.WorkerTaskCompleted - Record Class in akka.javasdk.agent.autonomous
Worker side: this agent finished its delegated subtask.
Notification.WorkerTaskReceived - Record Class in akka.javasdk.agent.autonomous
Worker side: this agent accepted a delegated subtask from the orchestrator.
NotificationPublisher<T> - Interface in akka.javasdk
A publisher for sending notifications to external subscribers.
NotificationPublisher.NotificationStream<T> - Interface in akka.javasdk
A helper interface allowing a type safe subscription to a notification stream.
notifications() - Method in class akka.javasdk.agent.task.TaskEntity
 
notifications() - Method in class akka.javasdk.impl.agent.task.BacklogEntity
 
notificationStream() - Method in interface akka.javasdk.client.AutonomousAgentClient
Subscribe to lifecycle notifications for this agent instance.
notificationStream() - Method in interface akka.javasdk.client.TaskClient
Subscribe to notifications published by the task entity.
notificationStream(Function<T, NotificationPublisher.NotificationStream<R>>) - Method in interface akka.javasdk.client.EventSourcedEntityClient
Pass in an Event Sourced Entity notification stream getter method reference, e.g.
notificationStream(Function<T, NotificationPublisher.NotificationStream<R>>) - Method in interface akka.javasdk.client.KeyValueEntityClient
Pass in a Key Value Entity notification stream getter method reference, e.g.
notificationStream(Function<T, NotificationPublisher.NotificationStream<R>>) - Method in interface akka.javasdk.client.WorkflowClient
Pass in a Workflow notification stream getter method reference, e.g.
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

ObjectMetadata - Class in akka.javasdk.objectstorage
Metadata for an object stored in a named bucket.
ObjectMetadata(String, long, Optional<ContentType>, Optional<String>, Instant) - Constructor for class akka.javasdk.objectstorage.ObjectMetadata
 
ObjectStorage - Interface in akka.javasdk.objectstorage
Client for a single named bucket.
ObjectStorageProvider - Interface in akka.javasdk.objectstorage
Entry point for object storage.
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(TeamLeadership.TeamMember, TeamLeadership.TeamMember...) - Static method in interface akka.javasdk.agent.autonomous.capability.TeamLeadership
Create a team leadership capability with the given member types.
of(TaskDefinition<?>, TaskDefinition<?>...) - Static method in class akka.javasdk.agent.autonomous.capability.TaskAcceptance
Create a task acceptance capability for the given task definitions.
of(Class<? extends AutonomousAgent>) - Static method in interface akka.javasdk.agent.autonomous.capability.TeamLeadership.TeamMember
Create a team member type for the given agent class.
of(Class<? extends AutonomousAgent>, Class<? extends AutonomousAgent>...) - Static method in interface akka.javasdk.agent.autonomous.capability.Moderation
Create a moderation capability with the given participant agent types.
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.
OK - Static variable in record class akka.javasdk.agent.Guardrail.Result
 
ollama() - Static method in interface akka.javasdk.agent.ModelProvider
Settings for the Ollama Large Language Model provider.
Ollama(String, String, Double, Double, Duration, Duration, int, boolean, List<HttpHeader>) - Constructor for record class akka.javasdk.agent.ModelProvider.Ollama
Creates an instance of a Ollama record class.
onComplete(R) - Method in interface akka.javasdk.agent.task.TaskRule
Evaluate the task result before accepting completion.
OneArgCommandHandler(Function2<?, ?, Workflow.Effect<Done>>, Object) - Constructor for record class akka.javasdk.workflow.Workflow.CommandHandler.OneArgCommandHandler
Creates an instance of a OneArgCommandHandler record class.
OneArgStepHandler(Function2<?, ?, Workflow.StepEffect>, Object) - Constructor for record class akka.javasdk.workflow.Workflow.StepHandler.OneArgStepHandler
Creates an instance of a OneArgStepHandler 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.
onShutdown() - Method in interface akka.javasdk.ServiceSetup
The on shutdown hook runs on each service instance when it shuts down — not on the service as a whole.
onStartup() - Method in interface akka.javasdk.ServiceSetup
The on startup hook is called every time a service instance boots up.
onUnhandledException(UnhandledExceptionContext) - Method in interface akka.javasdk.UnhandledExceptionHandler
Invoked when the runtime catches an exception thrown by user code that was not turned into a CommandException or a deliberate HTTP error response.
openAi() - Static method in interface akka.javasdk.agent.ModelProvider
Settings for the OpenAI Large Language Model provider.
OpenAi(String, String, String, double, double, int, int, Duration, Duration, int, boolean, List<HttpHeader>) - 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.
orchestratorComponentId() - Method in record class akka.javasdk.agent.autonomous.Notification.WorkerTaskReceived
Returns the value of the orchestratorComponentId record component.
orchestratorInstanceId() - Method in record class akka.javasdk.agent.autonomous.Notification.WorkerTaskReceived
Returns the value of the orchestratorInstanceId record component.
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.
outputTokens() - Method in record class akka.javasdk.agent.Agent.TokenUsage
Returns the value of the outputTokens record component.
outputTokens() - Method in record class akka.javasdk.agent.autonomous.AutonomousAgent.TokenUsage
Returns the value of the outputTokens record component.
outputTokens() - Method in record class akka.javasdk.agent.SessionMessage.TokenUsage
Returns the value of the outputTokens record component.

P

params(Map<String, String>) - Method in class akka.javasdk.agent.task.TaskTemplate
Resolve the template with named parameters, returning a submittable Task.
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.
parseResponseBody(Function<byte[], T>) - Method in interface akka.javasdk.http.RequestBuilder
Converts the response body to the specified type using the provided parser function.
participantComponentId() - Method in record class akka.javasdk.agent.autonomous.Notification.ConversationParticipantReady
Returns the value of the participantComponentId record component.
participantComponentId() - Method in record class akka.javasdk.agent.autonomous.Notification.ConversationParticipantSetupFailed
Returns the value of the participantComponentId record component.
participantComponentId() - Method in record class akka.javasdk.agent.autonomous.Notification.ConversationTurnReceived
Returns the value of the participantComponentId record component.
participantComponentIds() - Method in record class akka.javasdk.agent.autonomous.Notification.ConversationCreated
Returns the value of the participantComponentIds record component.
participantInstanceId() - Method in record class akka.javasdk.agent.autonomous.Notification.ConversationParticipantReady
Returns the value of the participantInstanceId record component.
participantInstanceId() - Method in record class akka.javasdk.agent.autonomous.Notification.ConversationParticipantSetupFailed
Returns the value of the participantInstanceId record component.
participantInstanceId() - Method in record class akka.javasdk.agent.autonomous.Notification.ConversationTurnReceived
Returns the value of the participantInstanceId record component.
participantInstanceIds() - Method in record class akka.javasdk.agent.autonomous.Notification.ConversationCreated
Returns the value of the participantInstanceIds record component.
ParticipantTurnSubmitted(String, int) - Constructor for record class akka.javasdk.agent.autonomous.Notification.ParticipantTurnSubmitted
Creates an instance of a ParticipantTurnSubmitted record class.
passed() - Method in interface akka.javasdk.agent.EvaluationResult
 
passed() - Method in record class akka.javasdk.agent.evaluator.HallucinationEvaluator.Result
Returns the value of the passed record component.
passed() - Method in record class akka.javasdk.agent.evaluator.SummarizationEvaluator.Result
Returns the value of the passed record component.
passed() - Method in record class akka.javasdk.agent.evaluator.ToxicityEvaluator.Result
Returns the value of the passed record component.
passed() - Method in record class akka.javasdk.agent.Guardrail.Result
Returns the value of the passed record component.
passivationDelay() - Method in interface akka.javasdk.workflow.Workflow.WorkflowSettings
 
passivationDelay(Duration) - Method in class akka.javasdk.workflow.Workflow.WorkflowSettingsBuilder
A paused (or finished) workflow will be kept in memory for the given delay before being passivated.
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() - Method in record class akka.javasdk.agent.autonomous.Notification.ConversationCreated
Returns the value of the pattern record component.
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.
pause(Workflow.PauseSettings) - Method in interface akka.javasdk.workflow.Workflow.Effect.Builder
Pause the workflow execution with advanced configuration options.
pause(Workflow.PauseSettings) - Method in interface akka.javasdk.workflow.Workflow.Effect.PersistenceEffectBuilder
Pause the workflow execution with advanced configuration options.
pause(String) - Method in interface akka.javasdk.workflow.Workflow.Effect.Builder
Pause the workflow execution with a reason description and wait for an external input, e.g.
pause(String) - Method in interface akka.javasdk.workflow.Workflow.Effect.PersistenceEffectBuilder
Pause the workflow execution with a reason description and wait for an external input, e.g.
pauseSetting(Duration) - Method in class akka.javasdk.workflow.Workflow
Creates a builder for configuring advanced pause settings with timeout and handler.
PauseSettings(Optional<String>, Duration, Workflow.CommandHandler) - Constructor for record class akka.javasdk.workflow.Workflow.PauseSettings
Creates an instance of a PauseSettings record class.
PauseSettingsBuilder(Duration) - Constructor for record class akka.javasdk.workflow.Workflow.PauseSettingsBuilder
 
PauseSettingsBuilder(Duration, Optional<String>) - Constructor for record class akka.javasdk.workflow.Workflow.PauseSettingsBuilder
Creates an instance of a PauseSettingsBuilder record class.
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.
Pdf(byte[], Optional<String>) - Constructor for record class akka.javasdk.impl.agent.DataMessageContentImpl.Pdf
Creates an instance of a Pdf record class.
PdfMessageContent() - Constructor for record class akka.javasdk.agent.MessageContent.PdfMessageContent
Creates an instance of a PdfMessageContent record class.
PdfUriMessageContent(String) - Constructor for record class akka.javasdk.agent.SessionMessage.MessageContent.PdfUriMessageContent
Creates an instance of a PdfUriMessageContent record class.
PdfUrlMessageContent(URI) - Constructor for record class akka.javasdk.agent.MessageContent.PdfUrlMessageContent
Creates an instance of a PdfUrlMessageContent record class.
PdfUrlMessageContent(URL) - Constructor for record class akka.javasdk.agent.MessageContent.PdfUrlMessageContent
Deprecated, for removal: This API element is subject to removal in a future version.
PENDING - Enum constant in enum class akka.javasdk.agent.task.TaskStatus
Created but not yet assigned to an agent.
pendingDependencyTaskIds() - Method in record class akka.javasdk.agent.autonomous.Notification.TaskDependencyStuck
Returns the value of the pendingDependencyTaskIds record component.
pendingDependencyTaskIds() - Method in record class akka.javasdk.agent.autonomous.Notification.TaskDependencyWait
Returns the value of the pendingDependencyTaskIds record component.
pendingTaskIds() - Method in class akka.javasdk.agent.autonomous.AgentState
The ids of tasks that are pending (queued but not yet started).
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.
persistAllWithMetadata(List<EventWithMetadata<? extends E>>) - Method in interface akka.javasdk.eventsourcedentity.EventSourcedEntity.Effect.Builder
Persist the passed List of events and additional metadata together with the events.
persistWithMetadata(E, Metadata) - Method in interface akka.javasdk.eventsourcedentity.EventSourcedEntity.Effect.Builder
Persist a single event and additional metadata together with the event.
phase() - Method in class akka.javasdk.agent.autonomous.AgentState
The current phase of the agent (e.g.
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
 
presencePenalty() - Method in record class akka.javasdk.agent.ModelProvider.AzureOpenAi
Returns the value of the presencePenalty record component.
presencePenalty() - Method in record class akka.javasdk.agent.ModelProvider.MistralAi
Returns the value of the presencePenalty record component.
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 to a topic or service stream.
produce(S, Metadata) - Method in interface akka.javasdk.consumer.Consumer.Effect.Builder
Produce a message with custom metadata to a topic or service stream.
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.
projectId() - Method in record class akka.javasdk.agent.ModelProvider.VertexAi
Returns the value of the projectId record component.
prompt() - Method in record class akka.javasdk.agent.PromptTemplate.Event.Updated
Returns the value of the prompt record component.
prompt(String, String) - Method in class akka.javasdk.agent.evaluator.HallucinationEvaluator
 
prompt(String, String) - Method in class akka.javasdk.agent.evaluator.SummarizationEvaluator
 
prompt(String, String) - Method in class akka.javasdk.agent.evaluator.ToxicityEvaluator
 
Prompt(String) - Constructor for record class akka.javasdk.agent.PromptTemplate.Prompt
Creates an instance of a Prompt record class.
promptCaching() - Method in record class akka.javasdk.agent.ModelProvider.Bedrock
Returns the value of the promptCaching record component.
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
 
ProtoEventTypes - Annotation Interface in akka.javasdk.annotations
Declares the concrete protobuf message classes used as events.
publish(T) - Method in interface akka.javasdk.NotificationPublisher
Publishes a single notification message to all subscribers.
publishSink() - Method in interface akka.javasdk.NotificationPublisher
Returns an Akka Streams Sink that publishes each element it receives as a notification.
publishTokenStream(Source<String, NotUsed>, int, Duration, Function<String, T>, Materializer) - Method in interface akka.javasdk.NotificationPublisher
Publishes a stream of string tokens (typically from an LLM response) as batched notifications.
put(String, ByteString) - Method in interface akka.javasdk.objectstorage.ObjectStorage
Store an object without an explicit content type.
put(String, ByteString, ContentType) - Method in interface akka.javasdk.objectstorage.ObjectStorage
Store an object with an explicit content type.
put(String, ByteString, ContentType, Map<String, String>) - Method in interface akka.javasdk.objectstorage.ObjectStorage
Store an object with an explicit content type.
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
 
putAsync(String, ByteString) - Method in interface akka.javasdk.objectstorage.ObjectStorage
putAsync(String, ByteString, ContentType) - Method in interface akka.javasdk.objectstorage.ObjectStorage
putAsync(String, ByteString, ContentType, Map<String, String>) - Method in interface akka.javasdk.objectstorage.ObjectStorage
putStreamAsync(String, Source<ByteString, ?>) - Method in interface akka.javasdk.objectstorage.ObjectStorage
Store an object from a streaming source without an explicit content type.
putStreamAsync(String, Source<ByteString, ?>, ContentType) - Method in interface akka.javasdk.objectstorage.ObjectStorage
Store an object from a streaming source with an explicit content type.
putStreamAsync(String, Source<ByteString, ?>, ContentType, Map<String, String>) - Method in interface akka.javasdk.objectstorage.ObjectStorage
Store an object from a streaming source with an explicit content type.

Q

query() - Method in record class akka.javasdk.agent.evaluator.HallucinationEvaluator.EvaluationRequest
Returns the value of the query record component.
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

randomSeed() - Method in record class akka.javasdk.agent.ModelProvider.MistralAi
Returns the value of the randomSeed record component.
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.
readLast(int, MemoryFilter.MemoryFilterSupplier) - Method in record class akka.javasdk.agent.MemoryProvider.LimitedWindowMemoryProvider
Creates a new memory provider with an updated history limit and multiple filters applied.
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(MemoryFilter.MemoryFilterSupplier) - Method in record class akka.javasdk.agent.MemoryProvider.LimitedWindowMemoryProvider
Creates a read-only version of this memory provider with multiple filters applied.
ReadOnly - Enum constant in enum class akka.javasdk.annotations.mcp.ToolAnnotation
The tool does not modify its environment.
reason() - Method in record class akka.javasdk.agent.autonomous.Notification.ConversationParticipantSetupFailed
Returns the value of the reason record component.
reason() - Method in record class akka.javasdk.agent.autonomous.Notification.DependencyResolved
Returns the value of the reason record component.
reason() - Method in record class akka.javasdk.agent.autonomous.Notification.IterationFailed
Returns the value of the reason record component.
reason() - Method in record class akka.javasdk.agent.autonomous.Notification.Resumed
Returns the value of the reason record component.
reason() - Method in record class akka.javasdk.agent.autonomous.Notification.Stopped
Returns the value of the reason record component.
reason() - Method in record class akka.javasdk.agent.autonomous.Notification.Suspended
Returns the value of the reason record component.
reason() - Method in record class akka.javasdk.agent.autonomous.Notification.TaskCancelled
Returns the value of the reason record component.
reason() - Method in record class akka.javasdk.agent.autonomous.Notification.TaskFailed
Returns the value of the reason record component.
reason() - Method in record class akka.javasdk.agent.autonomous.Notification.TaskResultRejected
Returns the value of the reason record component.
reason() - Method in record class akka.javasdk.agent.autonomous.Notification.TaskStruggleDetected
Returns the value of the reason record component.
reason() - Method in record class akka.javasdk.agent.autonomous.Notification.TeamMemberSetupFailed
Returns the value of the reason record component.
reason() - Method in record class akka.javasdk.agent.task.TaskEntity.RejectResultRequest
Returns the value of the reason record component.
reason() - Method in record class akka.javasdk.agent.task.TaskEvent.TaskCancelled
Returns the value of the reason record component.
reason() - Method in record class akka.javasdk.agent.task.TaskEvent.TaskFailed
Returns the value of the reason record component.
reason() - Method in record class akka.javasdk.agent.task.TaskEvent.TaskResultRejected
Returns the value of the reason record component.
reason() - Method in exception class akka.javasdk.agent.task.TaskException
The reason the task failed or was cancelled.
reason() - Method in record class akka.javasdk.agent.task.TaskNotification.Cancelled
Returns the value of the reason record component.
reason() - Method in record class akka.javasdk.agent.task.TaskNotification.Failed
Returns the value of the reason record component.
reason() - Method in record class akka.javasdk.agent.task.TaskNotification.ResultRejected
Returns the value of the reason record component.
reason() - Method in record class akka.javasdk.agent.task.TaskRule.Result.Rejected
Returns the value of the reason record component.
reason() - Method in record class akka.javasdk.workflow.Workflow.PauseSettings
Returns the value of the reason record component.
reason() - Method in record class akka.javasdk.workflow.Workflow.PauseSettingsBuilder
Returns the value of the reason record component.
reason(String) - Method in record class akka.javasdk.workflow.Workflow.PauseSettingsBuilder
Specify pause reason
reasoningEffort() - Method in record class akka.javasdk.agent.ModelProvider.AzureOpenAi
Returns the value of the reasoningEffort record component.
reasoningTokenBudget() - Method in record class akka.javasdk.agent.ModelProvider.Bedrock
Returns the value of the reasoningTokenBudget record component.
reassign(TaskEntity.ReassignRequest) - Method in class akka.javasdk.agent.task.TaskEntity
 
reassignmentContext() - Method in record class akka.javasdk.agent.task.TaskState
Returns the value of the reassignmentContext record component.
ReassignRequest(String, String) - Constructor for record class akka.javasdk.agent.task.TaskEntity.ReassignRequest
Creates an instance of a ReassignRequest record class.
RecoverStrategy(int, String, Optional<T>, Optional<Workflow.StepHandler>) - Constructor for record class akka.javasdk.workflow.Workflow.RecoverStrategy
Creates an instance of a RecoverStrategy record class.
recovery() - Method in record class akka.javasdk.workflow.Workflow.StepSettings
Returns the value of the recovery record component.
RecoveryInput(int, String, Function2<?, I, Workflow.StepEffect>) - Constructor for record class akka.javasdk.workflow.Workflow.RecoverStrategy.RecoveryInput
Creates an instance of a RecoveryInput record class.
referenceText() - Method in record class akka.javasdk.agent.evaluator.HallucinationEvaluator.EvaluationRequest
Returns the value of the referenceText record component.
region() - Method in record class akka.javasdk.agent.ModelProvider.Bedrock
Returns the value of the region record component.
Rejected(String) - Constructor for record class akka.javasdk.agent.task.TaskRule.Result.Rejected
Creates an instance of a Rejected record class.
rejectResult(TaskEntity.RejectResultRequest) - Method in class akka.javasdk.agent.task.TaskEntity
 
RejectResultRequest(String, String) - Constructor for record class akka.javasdk.agent.task.TaskEntity.RejectResultRequest
Creates an instance of a RejectResultRequest record class.
release(String) - Method in class akka.javasdk.impl.agent.task.BacklogEntity
Release a claimed task back to unclaimed.
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.
RepeatedIterationFailure(int, String) - Constructor for record class akka.javasdk.agent.autonomous.Notification.RepeatedIterationFailure
Creates an instance of a RepeatedIterationFailure record class.
ReplicationFilter - Interface in akka.javasdk.eventsourcedentity
Replication filter for controlling which regions participate in event replication for an Event Sourced Entity.
ReplicationFilter - Interface in akka.javasdk.keyvalueentity
Replication filter for controlling which regions participate in replication for a Key Value Entity.
ReplicationFilter.Builder - Interface in akka.javasdk.eventsourcedentity
Create the Builder with ReplicationFilter.includeRegion or the other factory methods in ReplicationFilter.
ReplicationFilter.Builder - Interface in akka.javasdk.keyvalueentity
Create the Builder with ReplicationFilter.includeRegion or the other factory methods in ReplicationFilter.
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.
requestGuardrails(Class<? extends Guardrail>...) - Method in interface akka.javasdk.agent.autonomous.AgentDefinition
Guardrails evaluated on requests before they are sent to the LLM.
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.
responseConformsTo(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.
responseGuardrails(Class<? extends Guardrail>...) - Method in interface akka.javasdk.agent.autonomous.AgentDefinition
Guardrails evaluated on responses received from the LLM.
responseTimeout() - Method in record class akka.javasdk.agent.ModelProvider.Anthropic
Returns the value of the responseTimeout record component.
responseTimeout() - Method in record class akka.javasdk.agent.ModelProvider.AzureOpenAi
Returns the value of the responseTimeout record component.
responseTimeout() - Method in record class akka.javasdk.agent.ModelProvider.Bedrock
Returns the value of the responseTimeout record component.
responseTimeout() - Method in record class akka.javasdk.agent.ModelProvider.GoogleAIGemini
Returns the value of the responseTimeout record component.
responseTimeout() - Method in record class akka.javasdk.agent.ModelProvider.HuggingFace
Returns the value of the responseTimeout record component.
responseTimeout() - Method in record class akka.javasdk.agent.ModelProvider.MistralAi
Returns the value of the responseTimeout record component.
responseTimeout() - Method in record class akka.javasdk.agent.ModelProvider.Ollama
Returns the value of the responseTimeout record component.
responseTimeout() - Method in record class akka.javasdk.agent.ModelProvider.OpenAi
Returns the value of the responseTimeout record component.
responseTimeout() - Method in record class akka.javasdk.agent.ModelProvider.VertexAi
Returns the value of the responseTimeout record component.
result() - Method in record class akka.javasdk.agent.task.TaskEvent.TaskCompleted
Returns the value of the result record component.
result() - Method in record class akka.javasdk.agent.task.TaskNotification.Completed
Returns the value of the result record component.
result() - Method in record class akka.javasdk.agent.task.TaskSnapshot
Returns the value of the result record component.
result() - Method in record class akka.javasdk.agent.task.TaskState
Returns the value of the result record component.
result(TaskDefinition<R>) - Method in interface akka.javasdk.client.TaskClient
Blocks until the task reaches a terminal state and returns the typed result.
Result(boolean, String) - Constructor for record class akka.javasdk.agent.Guardrail.Result
Creates an instance of a Result record class.
Result(String, boolean) - Constructor for record class akka.javasdk.agent.evaluator.HallucinationEvaluator.Result
Creates an instance of a Result record class.
Result(String, boolean) - Constructor for record class akka.javasdk.agent.evaluator.SummarizationEvaluator.Result
Creates an instance of a Result record class.
Result(String, boolean) - Constructor for record class akka.javasdk.agent.evaluator.ToxicityEvaluator.Result
Creates an instance of a Result record class.
RESULT_REJECTED - Enum constant in enum class akka.javasdk.agent.task.TaskStatus
A TaskRule rejected the result.
resultAsync(TaskDefinition<R>) - Method in interface akka.javasdk.client.TaskClient
resultConformsTo(Class<S>) - Method in class akka.javasdk.agent.task.Task
Set the expected result type.
resultConformsTo(Class<S>) - Method in class akka.javasdk.agent.task.TaskTemplate
Set the expected result type.
ResultRejected(String, String, String) - Constructor for exception class akka.javasdk.agent.task.TaskException.ResultRejected
 
ResultRejected(String, String, String, String) - Constructor for record class akka.javasdk.agent.task.TaskNotification.ResultRejected
Creates an instance of a ResultRejected record class.
resultType() - Method in class akka.javasdk.agent.task.Task
 
resultType() - Method in interface akka.javasdk.agent.task.TaskDefinition
The expected result type.
resultType() - Method in class akka.javasdk.agent.task.TaskTemplate
 
resultTypeName() - Method in record class akka.javasdk.agent.task.TaskEntity.CreateRequest
Returns the value of the resultTypeName record component.
resultTypeName() - Method in record class akka.javasdk.agent.task.TaskEvent.TaskCreated
Returns the value of the resultTypeName record component.
resultTypeName() - Method in record class akka.javasdk.agent.task.TaskState
Returns the value of the resultTypeName record component.
resume() - Method in interface akka.javasdk.client.AutonomousAgentClient
Resume a previously suspended agent.
resume(Class<? extends Workflow<?>>) - Method in interface akka.javasdk.client.WorkflowClient
Resume the workflow identified by this client's workflow id.
resumeAsync() - Method in interface akka.javasdk.client.AutonomousAgentClient
resumeAsync(Class<? extends Workflow<?>>) - Method in interface akka.javasdk.client.WorkflowClient
Resumed(String) - Constructor for record class akka.javasdk.agent.autonomous.Notification.Resumed
Creates an instance of a Resumed record class.
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.
returnThinking() - Method in record class akka.javasdk.agent.ModelProvider.Bedrock
Returns the value of the returnThinking record component.
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.mcp.McpPrompt
 
roles() - Method in record class akka.javasdk.agent.MemoryFilter.Exclude
Returns the value of the roles record component.
roles() - Method in record class akka.javasdk.agent.MemoryFilter.Include
Returns the value of the roles record component.
rowState() - Method in class akka.javasdk.view.TableUpdater
Returns the current state of the row for the subject that is being updated.
ruleClasses() - Method in class akka.javasdk.agent.task.Task
Rule classes that validate the result before accepting completion, or an empty list.
ruleClasses() - Method in interface akka.javasdk.agent.task.TaskDefinition
The validation rule classes for this task definition.
ruleClasses() - Method in class akka.javasdk.agent.task.TaskTemplate
Rule classes that validate the result before accepting completion, or an empty list.
ruleClassName() - Method in record class akka.javasdk.agent.task.TaskEntity.RejectResultRequest
Returns the value of the ruleClassName record component.
ruleClassName() - Method in record class akka.javasdk.agent.task.TaskEvent.TaskResultRejected
Returns the value of the ruleClassName record component.
ruleClassName() - Method in exception class akka.javasdk.agent.task.TaskException.ResultRejected
 
ruleClassName() - Method in record class akka.javasdk.agent.task.TaskNotification.ResultRejected
Returns the value of the ruleClassName record component.
ruleClassNames() - Method in record class akka.javasdk.agent.task.TaskEntity.CreateRequest
Returns the value of the ruleClassNames record component.
ruleClassNames() - Method in record class akka.javasdk.agent.task.TaskEvent.TaskCreated
Returns the value of the ruleClassNames record component.
ruleClassNames() - Method in record class akka.javasdk.agent.task.TaskState
Returns the value of the ruleClassNames record component.
rules(Class<? extends TaskRule<R>>, Class<? extends TaskRule<R>>...) - Method in class akka.javasdk.agent.task.Task
Return a new task with the given rules.
rules(Class<? extends TaskRule<R>>, Class<? extends TaskRule<R>>...) - Method in class akka.javasdk.agent.task.TaskTemplate
Return a new task template with the given rules.
runSingleTask(Task<?>) - Method in interface akka.javasdk.client.AutonomousAgentClient
Create a task, assign it to a fresh agent instance, and automatically stop the agent when done.
runSingleTaskAsync(Task<?>) - Method in interface akka.javasdk.client.AutonomousAgentClient

S

safePrompt() - Method in record class akka.javasdk.agent.ModelProvider.MistralAi
Returns the value of the safePrompt record component.
sanitize(String) - Method in interface akka.javasdk.Sanitizer
 
Sanitizer - Interface in akka.javasdk
Sanitizer that applies all configured sanitization rules for the service.
seed() - Method in record class akka.javasdk.agent.ModelProvider.AzureOpenAi
Returns the value of the seed record component.
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.
sendThinking() - Method in record class akka.javasdk.agent.ModelProvider.Bedrock
Returns the value of the sendThinking record component.
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
Return a stream of events as an HTTP SSE response.
serverSentEvents(Source<T, ?>, Function<T, String>) - Static method in class akka.javasdk.http.HttpResponses
Return a stream of events as an HTTP SSE response.
serverSentEvents(Source<T, ?>, Function<T, String>, Function<T, String>) - Static method in class akka.javasdk.http.HttpResponses
Return a stream of events as an HTTP Server Sent Events (SSE) response.
serverSentEventsForView(Source<EntryWithMetadata<T>, ?>) - Static method in class akka.javasdk.http.HttpResponses
Convenience for emitting a streaming-updates view query as resume-able SSE stream, where the latest seen event is where the query continues on reconnect.
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.
serviceVersion() - Method in record class akka.javasdk.agent.ModelProvider.AzureOpenAi
Returns the value of the serviceVersion record component.
SessionHistory - Record Class in akka.javasdk.agent
 
SessionHistory(List<SessionMessage>, long) - Constructor for record class akka.javasdk.agent.SessionHistory
 
SessionHistory(List<SessionMessage>, long, SessionMessage.TokenUsage) - Constructor for record class akka.javasdk.agent.SessionHistory
Creates an instance of a SessionHistory record class.
SessionHistoryResult - Interface in akka.javasdk.agent
SessionHistoryResult.Loaded - Record Class in akka.javasdk.agent
The entity returned the full history within its size limit.
SessionHistoryResult.Truncated - Record Class in akka.javasdk.agent
The entity could not deliver the full history within its in-memory size limit.
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, EventLogClient, Serializer, AgentRegistry, Materializer, SessionMemoryClient.MemorySettings) - Constructor for class akka.javasdk.impl.agent.SessionMemoryClient
 
SessionMemoryClient(ComponentClient, EventLogClient, Serializer, AgentRegistry, Materializer, 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, AgentRegistry) - Constructor for class akka.javasdk.agent.SessionMemoryEntity
 
SessionMemoryEntity.AddInteractionCmd - Record Class in akka.javasdk.agent
 
SessionMemoryEntity.AddMultimodalInteractionCmd - 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.Message - Interface in akka.javasdk.agent
 
SessionMemoryEntity.Event.MultimodalUserMessageAdded - 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
 
SessionMemoryInterceptor - Interface in akka.javasdk.agent
Interceptor for write operations on SessionMemory.
SessionMessage - Interface in akka.javasdk.agent
Interface for message representation used inside the SessionMemoryEntity state.
SessionMessage.AiMessage - Record Class in akka.javasdk.agent
 
SessionMessage.MessageContent - Interface in akka.javasdk.agent
 
SessionMessage.MessageContent.ImageUriMessageContent - Record Class in akka.javasdk.agent
 
SessionMessage.MessageContent.PdfUriMessageContent - Record Class in akka.javasdk.agent
 
SessionMessage.MessageContent.TextMessageContent - Record Class in akka.javasdk.agent
 
SessionMessage.MultimodalUserMessage - Record Class in akka.javasdk.agent
 
SessionMessage.TokenUsage - 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
 
SessionMessageConverter - Class in akka.javasdk.agent
 
SessionMessageConverter() - Constructor for class akka.javasdk.agent.SessionMessageConverter
 
set(String, String) - Method in interface akka.javasdk.Metadata
Set the string value for the given key.
setLimitedWindow(SessionMemoryEntity.LimitedWindow) - Method in class akka.javasdk.agent.SessionMemoryEntity
 
settings() - Method in class akka.javasdk.workflow.Workflow
 
setup(AgentSetup) - Method in interface akka.javasdk.client.AutonomousAgentClient
Apply per-instance configuration to this agent.
Setup - Annotation Interface in akka.javasdk.annotations
Mark a class as a central configuration point for an entire service.
setupAsync(AgentSetup) - Method in interface akka.javasdk.client.AutonomousAgentClient
SimilarityGuard - Class in akka.javasdk.agent
The SimilarityGuard evaluates the text by making a similarity search in a dataset of "bad examples".
SimilarityGuard(GuardrailContext) - Constructor for class akka.javasdk.agent.SimilarityGuard
 
single(Object) - Static method in interface akka.javasdk.DependencyProvider
Create a dependency provider that always returns the same instance for a given class.
size - Variable in class akka.javasdk.objectstorage.ObjectMetadata
Size of the object in bytes.
size() - Method in record class akka.javasdk.agent.SessionMessage.AiMessage
 
size() - Method in record class akka.javasdk.agent.SessionMessage.MultimodalUserMessage
 
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.MultimodalUserMessageAdded
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
 
SnapshotHandler - Annotation Interface in akka.javasdk.annotations
A Consumer or View can use this annotation on a method to define that it accepts snapshots from the EventSourcedEntity source.
Snapshots - Search tag in class akka.javasdk.eventsourcedentity.EventSourcedEntity
Section
source() - Method in interface akka.javasdk.client.ComponentStreamMethodRef
 
source() - Method in interface akka.javasdk.client.ViewStreamMethodRef
 
source() - Method in interface akka.javasdk.CloudEvent
The source of this CloudEvent.
source(A1) - Method in interface akka.javasdk.client.ComponentStreamMethodRef1
 
source(A1) - Method in interface akka.javasdk.client.ViewStreamMethodRef1
 
sourceComponentId() - Method in record class akka.javasdk.agent.autonomous.Notification.HandoffReceived
Returns the value of the sourceComponentId record component.
sourceInstanceId() - Method in record class akka.javasdk.agent.autonomous.Notification.HandoffReceived
Returns the value of the sourceInstanceId record component.
specversion() - Method in interface akka.javasdk.CloudEvent
The CloudEvent spec version.
start() - Method in class akka.javasdk.agent.task.TaskEntity
 
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
 
State(String, long, long, List<SessionMessage>, SessionMessage.TokenUsage, boolean, long) - 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.agent.task.TaskSnapshot
Returns the value of the status record component.
status() - Method in record class akka.javasdk.agent.task.TaskState
Returns the value of the status record component.
status() - Method in record class akka.javasdk.http.StrictResponse
 
stepEffects() - Method in class akka.javasdk.workflow.Workflow
 
stepHandler() - Method in record class akka.javasdk.workflow.Workflow.RecoverStrategy
Returns the value of the stepHandler record component.
stepLambda() - Method in record class akka.javasdk.workflow.Workflow.StepSettings
Returns the value of the stepLambda record component.
StepMethod(String, Method) - Constructor for record class akka.javasdk.workflow.Workflow.StepMethod
Creates an instance of a StepMethod record class.
stepName() - Method in record class akka.javasdk.workflow.Workflow.RecoverStrategy.RecoveryInput
Returns the value of the stepName record component.
stepName() - Method in record class akka.javasdk.workflow.Workflow.StepSettings
Returns the value of the stepName record component.
StepName - Annotation Interface in akka.javasdk.annotations
Annotation for providing a workflow step name
stepRecovery(Function<W, Workflow.StepEffect>, Workflow.RecoverStrategy<?>) - Method in class akka.javasdk.workflow.Workflow.WorkflowSettingsBuilder
Configure a specific step with a recovery strategy.
stepRecovery(Function2<W, I, Workflow.StepEffect>, Workflow.RecoverStrategy<?>) - Method in class akka.javasdk.workflow.Workflow.WorkflowSettingsBuilder
Configure a specific step with a recovery strategy.
stepSettings() - Method in interface akka.javasdk.workflow.Workflow.WorkflowSettings
 
StepSettings(String, Optional<Duration>, Optional<Workflow.RecoverStrategy<?>>, Optional<Object>) - Constructor for record class akka.javasdk.workflow.Workflow.StepSettings
Creates an instance of a StepSettings record class.
stepTimeout(Function<W, Workflow.StepEffect>, Duration) - Method in class akka.javasdk.workflow.Workflow.WorkflowSettingsBuilder
Configure a specific step with a timeout.
stepTimeout(Function2<W, I, Workflow.StepEffect>, Duration) - Method in class akka.javasdk.workflow.Workflow.WorkflowSettingsBuilder
Configure a specific step with a timeout.
stop() - Method in record class akka.javasdk.agent.ModelProvider.AzureOpenAi
Returns the value of the stop record component.
Stopped(String) - Constructor for record class akka.javasdk.agent.autonomous.Notification.Stopped
Creates an instance of a Stopped record class.
stopSequences() - Method in record class akka.javasdk.agent.ModelProvider.MistralAi
Returns the value of the stopSequences record component.
StorageObject - Class in akka.javasdk.objectstorage
An object retrieved from storage, including its metadata and full in-memory content.
StorageObject(ObjectMetadata, ByteString) - Constructor for class akka.javasdk.objectstorage.StorageObject
 
stream() - Method in interface akka.javasdk.NotificationPublisher
Returns a NotificationPublisher.NotificationStream handle that can be exposed via a Workflow method for external clients to subscribe to notifications.
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
 
streamText(Source<String, ?>) - Static method in class akka.javasdk.http.HttpResponses
 
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.
subjectId() - Method in interface akka.javasdk.UnhandledExceptionContext
The entity, workflow or agent id when the exception originated in a stateful component.
subtaskId() - Method in record class akka.javasdk.agent.autonomous.Notification.WorkerTaskCompleted
Returns the value of the subtaskId record component.
subtaskId() - Method in record class akka.javasdk.agent.autonomous.Notification.WorkerTaskReceived
Returns the value of the subtaskId record component.
subtaskIds() - Method in record class akka.javasdk.agent.autonomous.Notification.DelegationStarted
Returns the value of the subtaskIds record component.
succeeded() - Method in record class akka.javasdk.agent.autonomous.Notification.DelegationResolved
Returns the value of the succeeded record component.
succeededSubtaskIds() - Method in record class akka.javasdk.agent.autonomous.Notification.DelegationResolved
Returns the value of the succeededSubtaskIds record component.
success() - Method in record class akka.javasdk.agent.autonomous.Notification.DependencyResolved
Returns the value of the success record component.
SummarizationEvaluator - Class in akka.javasdk.agent.evaluator
An agent that acts as an LLM judge to evaluate a summarization task.
SummarizationEvaluator(ComponentClient, Config) - Constructor for class akka.javasdk.agent.evaluator.SummarizationEvaluator
 
SummarizationEvaluator.EvaluationRequest - Record Class in akka.javasdk.agent.evaluator
 
SummarizationEvaluator.Result - Record Class in akka.javasdk.agent.evaluator
 
summary() - Method in record class akka.javasdk.agent.evaluator.SummarizationEvaluator.EvaluationRequest
Returns the value of the summary record component.
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).
suspend() - Method in interface akka.javasdk.client.AutonomousAgentClient
Suspend the agent.
suspend(Class<? extends Workflow<?>>) - Method in interface akka.javasdk.client.WorkflowClient
Suspend the workflow identified by this client's workflow id.
suspend(Class<? extends Workflow<?>>, String) - Method in interface akka.javasdk.client.WorkflowClient
Suspend the workflow identified by this client's workflow id, recording a free-form reason.
suspend(String) - Method in interface akka.javasdk.client.AutonomousAgentClient
Suspend the agent with a reason.
suspendAsync() - Method in interface akka.javasdk.client.AutonomousAgentClient
suspendAsync(Class<? extends Workflow<?>>) - Method in interface akka.javasdk.client.WorkflowClient
suspendAsync(Class<? extends Workflow<?>>, String) - Method in interface akka.javasdk.client.WorkflowClient
suspendAsync(String) - Method in interface akka.javasdk.client.AutonomousAgentClient
suspended() - Method in class akka.javasdk.agent.autonomous.AgentState
Whether the agent is currently suspended.
Suspended(String) - Constructor for record class akka.javasdk.agent.autonomous.Notification.Suspended
Creates an instance of a Suspended record class.
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
 
targetComponentId() - Method in record class akka.javasdk.agent.autonomous.Notification.HandoffStarted
Returns the value of the targetComponentId record component.
targetInstanceId() - Method in record class akka.javasdk.agent.autonomous.Notification.HandoffStarted
Returns the value of the targetInstanceId record component.
Task<R> - Class in akka.javasdk.agent.task
A typed task definition — describes a kind of work and the expected result type.
TaskAcceptance - Class in akka.javasdk.agent.autonomous.capability
Declares that an agent can accept and process tasks of the specified types.
TaskAcceptance() - Constructor for class akka.javasdk.agent.autonomous.capability.TaskAcceptance
 
TaskAdded(String) - Constructor for record class akka.javasdk.impl.agent.task.BacklogEvent.TaskAdded
Creates an instance of a TaskAdded record class.
TaskAdded(String) - Constructor for record class akka.javasdk.impl.agent.task.BacklogNotification.TaskAdded
Creates an instance of a TaskAdded record class.
TaskApproachingMaxIterations(String, String, int, int) - Constructor for record class akka.javasdk.agent.autonomous.Notification.TaskApproachingMaxIterations
Creates an instance of a TaskApproachingMaxIterations record class.
TaskAssigned(String) - Constructor for record class akka.javasdk.agent.autonomous.Notification.TaskAssigned
Creates an instance of a TaskAssigned record class.
TaskAssigned(String, String, String) - Constructor for record class akka.javasdk.agent.task.TaskEvent.TaskAssigned
Creates an instance of a TaskAssigned record class.
TaskAttachment - Record Class in akka.javasdk.agent.task
A serializable reference to content attached to a task.
TaskAttachment(String, URI, String, String, String) - Constructor for record class akka.javasdk.agent.task.TaskAttachment
Creates an instance of a TaskAttachment record class.
TaskCancelled(String, String, String) - Constructor for record class akka.javasdk.agent.autonomous.Notification.TaskCancelled
Creates an instance of a TaskCancelled record class.
TaskCancelled(String, String, String) - Constructor for record class akka.javasdk.agent.task.TaskEvent.TaskCancelled
Creates an instance of a TaskCancelled record class.
TaskClaimed(String, String) - Constructor for record class akka.javasdk.impl.agent.task.BacklogEvent.TaskClaimed
Creates an instance of a TaskClaimed record class.
TaskClaimed(String, String) - Constructor for record class akka.javasdk.impl.agent.task.BacklogNotification.TaskClaimed
Creates an instance of a TaskClaimed record class.
TaskClient - Interface in akka.javasdk.client
Client for creating, querying, and completing tasks, bound to a specific task entity ID.
TaskCompleted(String, String) - Constructor for record class akka.javasdk.agent.autonomous.Notification.TaskCompleted
Creates an instance of a TaskCompleted record class.
TaskCompleted(String, String, String) - Constructor for record class akka.javasdk.agent.task.TaskEvent.TaskCompleted
Creates an instance of a TaskCompleted record class.
TaskCreated(String, String, String, String, String, List<String>, List<TaskAttachment>, List<String>) - Constructor for record class akka.javasdk.agent.task.TaskEvent.TaskCreated
Creates an instance of a TaskCreated record class.
TaskDefinition<R> - Interface in akka.javasdk.agent.task
A task definition declares what kind of work an agent can do — a description of the task and the expected result type.
TaskDependencyStuck(String, List<String>, long) - Constructor for record class akka.javasdk.agent.autonomous.Notification.TaskDependencyStuck
Creates an instance of a TaskDependencyStuck record class.
TaskDependencyWait(String, List<String>) - Constructor for record class akka.javasdk.agent.autonomous.Notification.TaskDependencyWait
Creates an instance of a TaskDependencyWait record class.
TaskEntity - Class in akka.javasdk.agent.task
 
TaskEntity(EventSourcedEntityContext, NotificationPublisher<TaskNotification>) - Constructor for class akka.javasdk.agent.task.TaskEntity
 
TaskEntity.CreateRequest - Record Class in akka.javasdk.agent.task
 
TaskEntity.ReassignRequest - Record Class in akka.javasdk.agent.task
 
TaskEntity.RejectResultRequest - Record Class in akka.javasdk.agent.task
 
TaskEvent - Interface in akka.javasdk.agent.task
 
TaskEvent.TaskAssigned - Record Class in akka.javasdk.agent.task
 
TaskEvent.TaskCancelled - Record Class in akka.javasdk.agent.task
 
TaskEvent.TaskCompleted - Record Class in akka.javasdk.agent.task
 
TaskEvent.TaskCreated - Record Class in akka.javasdk.agent.task
 
TaskEvent.TaskFailed - Record Class in akka.javasdk.agent.task
 
TaskEvent.TaskReassigned - Record Class in akka.javasdk.agent.task
 
TaskEvent.TaskResultRejected - Record Class in akka.javasdk.agent.task
 
TaskEvent.TaskStarted - Record Class in akka.javasdk.agent.task
 
TaskException - Exception Class in akka.javasdk.agent.task
Base exception for task terminal states.
TaskException.Cancelled - Exception Class in akka.javasdk.agent.task
Thrown when a task reaches the TaskStatus.CANCELLED state.
TaskException.Failed - Exception Class in akka.javasdk.agent.task
Thrown when a task reaches the TaskStatus.FAILED state.
TaskException.ResultRejected - Exception Class in akka.javasdk.agent.task
Thrown when a task result is rejected by a validation rule.
TaskException.TypeMismatch - Exception Class in akka.javasdk.agent.task
Thrown when a task result is retrieved with a mismatched task definition.
TaskFailed(String, String, String) - Constructor for record class akka.javasdk.agent.autonomous.Notification.TaskFailed
Creates an instance of a TaskFailed record class.
TaskFailed(String, String, String) - Constructor for record class akka.javasdk.agent.task.TaskEvent.TaskFailed
Creates an instance of a TaskFailed record class.
taskId() - Method in record class akka.javasdk.agent.autonomous.Notification.BacklogTaskClaimed
Returns the value of the taskId record component.
taskId() - Method in record class akka.javasdk.agent.autonomous.Notification.DependencyResolved
Returns the value of the taskId record component.
taskId() - Method in record class akka.javasdk.agent.autonomous.Notification.HandoffReceived
Returns the value of the taskId record component.
taskId() - Method in record class akka.javasdk.agent.autonomous.Notification.HandoffStarted
Returns the value of the taskId record component.
taskId() - Method in record class akka.javasdk.agent.autonomous.Notification.IterationFailed
Returns the value of the taskId record component.
taskId() - Method in record class akka.javasdk.agent.autonomous.Notification.TaskApproachingMaxIterations
Returns the value of the taskId record component.
taskId() - Method in record class akka.javasdk.agent.autonomous.Notification.TaskAssigned
Returns the value of the taskId record component.
taskId() - Method in record class akka.javasdk.agent.autonomous.Notification.TaskCancelled
Returns the value of the taskId record component.
taskId() - Method in record class akka.javasdk.agent.autonomous.Notification.TaskCompleted
Returns the value of the taskId record component.
taskId() - Method in record class akka.javasdk.agent.autonomous.Notification.TaskDependencyStuck
Returns the value of the taskId record component.
taskId() - Method in record class akka.javasdk.agent.autonomous.Notification.TaskDependencyWait
Returns the value of the taskId record component.
taskId() - Method in record class akka.javasdk.agent.autonomous.Notification.TaskFailed
Returns the value of the taskId record component.
taskId() - Method in record class akka.javasdk.agent.autonomous.Notification.TaskResultRejected
Returns the value of the taskId record component.
taskId() - Method in record class akka.javasdk.agent.autonomous.Notification.TaskStarted
Returns the value of the taskId record component.
taskId() - Method in record class akka.javasdk.agent.autonomous.Notification.TaskStruggleDetected
Returns the value of the taskId record component.
taskId() - Method in record class akka.javasdk.agent.task.TaskEvent.TaskAssigned
Returns the value of the taskId record component.
taskId() - Method in record class akka.javasdk.agent.task.TaskEvent.TaskCancelled
Returns the value of the taskId record component.
taskId() - Method in record class akka.javasdk.agent.task.TaskEvent.TaskCompleted
Returns the value of the taskId record component.
taskId() - Method in record class akka.javasdk.agent.task.TaskEvent.TaskCreated
Returns the value of the taskId record component.
taskId() - Method in record class akka.javasdk.agent.task.TaskEvent.TaskFailed
Returns the value of the taskId record component.
taskId() - Method in record class akka.javasdk.agent.task.TaskEvent.TaskReassigned
Returns the value of the taskId record component.
taskId() - Method in record class akka.javasdk.agent.task.TaskEvent.TaskResultRejected
Returns the value of the taskId record component.
taskId() - Method in record class akka.javasdk.agent.task.TaskEvent.TaskStarted
Returns the value of the taskId record component.
taskId() - Method in exception class akka.javasdk.agent.task.TaskException
The ID of the task that failed or was cancelled.
taskId() - Method in record class akka.javasdk.agent.task.TaskNotification.Cancelled
Returns the value of the taskId record component.
taskId() - Method in record class akka.javasdk.agent.task.TaskNotification.Completed
Returns the value of the taskId record component.
taskId() - Method in record class akka.javasdk.agent.task.TaskNotification.Failed
Returns the value of the taskId record component.
taskId() - Method in record class akka.javasdk.agent.task.TaskNotification.ResultRejected
Returns the value of the taskId record component.
taskId() - Method in interface akka.javasdk.agent.task.TaskNotification
 
taskId() - Method in record class akka.javasdk.agent.task.TaskState
Returns the value of the taskId record component.
taskId() - Method in record class akka.javasdk.impl.agent.task.BacklogEntity.ClaimRequest
Returns the value of the taskId record component.
taskId() - Method in record class akka.javasdk.impl.agent.task.BacklogEntity.TransferRequest
Returns the value of the taskId record component.
taskId() - Method in record class akka.javasdk.impl.agent.task.BacklogEvent.TaskAdded
Returns the value of the taskId record component.
taskId() - Method in record class akka.javasdk.impl.agent.task.BacklogEvent.TaskClaimed
Returns the value of the taskId record component.
taskId() - Method in record class akka.javasdk.impl.agent.task.BacklogEvent.TaskReleased
Returns the value of the taskId record component.
taskId() - Method in record class akka.javasdk.impl.agent.task.BacklogEvent.TaskTransferred
Returns the value of the taskId record component.
taskId() - Method in record class akka.javasdk.impl.agent.task.BacklogNotification.TaskAdded
Returns the value of the taskId record component.
taskId() - Method in record class akka.javasdk.impl.agent.task.BacklogNotification.TaskClaimed
Returns the value of the taskId record component.
taskId() - Method in record class akka.javasdk.impl.agent.task.BacklogNotification.TaskReleased
Returns the value of the taskId record component.
taskId() - Method in record class akka.javasdk.impl.agent.task.BacklogNotification.TaskTransferred
Returns the value of the taskId record component.
taskId() - Method in record class akka.javasdk.impl.agent.task.BacklogState.Entry
Returns the value of the taskId record component.
TaskKey - Record Class in akka.javasdk.agent.task
A reference to a task, holding its ID and name.
TaskKey(String, String) - Constructor for record class akka.javasdk.agent.task.TaskKey
Creates an instance of a TaskKey record class.
taskName() - Method in record class akka.javasdk.agent.autonomous.Notification.HandoffStarted
Returns the value of the taskName record component.
taskName() - Method in record class akka.javasdk.agent.autonomous.Notification.TaskApproachingMaxIterations
Returns the value of the taskName record component.
taskName() - Method in record class akka.javasdk.agent.autonomous.Notification.TaskCancelled
Returns the value of the taskName record component.
taskName() - Method in record class akka.javasdk.agent.autonomous.Notification.TaskCompleted
Returns the value of the taskName record component.
taskName() - Method in record class akka.javasdk.agent.autonomous.Notification.TaskFailed
Returns the value of the taskName record component.
taskName() - Method in record class akka.javasdk.agent.autonomous.Notification.TaskResultRejected
Returns the value of the taskName record component.
taskName() - Method in record class akka.javasdk.agent.autonomous.Notification.TaskStarted
Returns the value of the taskName record component.
taskName() - Method in record class akka.javasdk.agent.autonomous.Notification.TaskStruggleDetected
Returns the value of the taskName record component.
taskName() - Method in record class akka.javasdk.agent.task.TaskNotification.Cancelled
Returns the value of the taskName record component.
taskName() - Method in record class akka.javasdk.agent.task.TaskNotification.Completed
Returns the value of the taskName record component.
taskName() - Method in record class akka.javasdk.agent.task.TaskNotification.Failed
Returns the value of the taskName record component.
taskName() - Method in record class akka.javasdk.agent.task.TaskNotification.ResultRejected
Returns the value of the taskName record component.
taskName() - Method in interface akka.javasdk.agent.task.TaskNotification
 
TaskNotification - Interface in akka.javasdk.agent.task
Notifications published by task entities when they reach a terminal state.
TaskNotification.Cancelled - Record Class in akka.javasdk.agent.task
 
TaskNotification.Completed - Record Class in akka.javasdk.agent.task
 
TaskNotification.Failed - Record Class in akka.javasdk.agent.task
 
TaskNotification.ResultRejected - Record Class in akka.javasdk.agent.task
 
TaskReassigned(String, String, String, String) - Constructor for record class akka.javasdk.agent.task.TaskEvent.TaskReassigned
Creates an instance of a TaskReassigned record class.
TaskReleased(String) - Constructor for record class akka.javasdk.impl.agent.task.BacklogEvent.TaskReleased
Creates an instance of a TaskReleased record class.
TaskReleased(String) - Constructor for record class akka.javasdk.impl.agent.task.BacklogNotification.TaskReleased
Creates an instance of a TaskReleased record class.
TaskResultRejected(String, String, String) - Constructor for record class akka.javasdk.agent.autonomous.Notification.TaskResultRejected
Creates an instance of a TaskResultRejected record class.
TaskResultRejected(String, String, String, String) - Constructor for record class akka.javasdk.agent.task.TaskEvent.TaskResultRejected
Creates an instance of a TaskResultRejected record class.
TaskRule<R> - Interface in akka.javasdk.agent.task
A rule that validates the result of a task before accepting its completion.
TaskRule.Result - Interface in akka.javasdk.agent.task
 
TaskRule.Result.Accepted - Record Class in akka.javasdk.agent.task
 
TaskRule.Result.Rejected - Record Class in akka.javasdk.agent.task
 
tasks() - Method in record class akka.javasdk.impl.agent.task.BacklogState
Returns the value of the tasks record component.
TaskSnapshot<R> - Record Class in akka.javasdk.agent.task
A point-in-time snapshot of a task's state, with a typed result.
TaskSnapshot(String, String, String, TaskStatus, Optional<R>, Optional<String>) - Constructor for record class akka.javasdk.agent.task.TaskSnapshot
Creates an instance of a TaskSnapshot record class.
TaskStarted(String, String) - Constructor for record class akka.javasdk.agent.autonomous.Notification.TaskStarted
Creates an instance of a TaskStarted record class.
TaskStarted(String, String) - Constructor for record class akka.javasdk.agent.task.TaskEvent.TaskStarted
Creates an instance of a TaskStarted record class.
TaskState - Record Class in akka.javasdk.agent.task
State of a task entity.
TaskState(String, String, String, String, TaskStatus, String, Optional<String>, Optional<String>, List<String>, Optional<String>, List<TaskAttachment>, List<String>, List<String>) - Constructor for record class akka.javasdk.agent.task.TaskState
Creates an instance of a TaskState record class.
TaskStatus - Enum Class in akka.javasdk.agent.task
The lifecycle status of a Task.
TaskStruggleDetected(String, String, String, int, int) - Constructor for record class akka.javasdk.agent.autonomous.Notification.TaskStruggleDetected
Creates an instance of a TaskStruggleDetected record class.
TaskTemplate<R> - Class in akka.javasdk.agent.task
A task definition with a parameterized instruction template.
TaskTransferred(String, String) - Constructor for record class akka.javasdk.impl.agent.task.BacklogEvent.TaskTransferred
Creates an instance of a TaskTransferred record class.
TaskTransferred(String, String) - Constructor for record class akka.javasdk.impl.agent.task.BacklogNotification.TaskTransferred
Creates an instance of a TaskTransferred record class.
TeamCreated(String, List<String>, List<String>) - Constructor for record class akka.javasdk.agent.autonomous.Notification.TeamCreated
Creates an instance of a TeamCreated record class.
TeamDisbanded(String) - Constructor for record class akka.javasdk.agent.autonomous.Notification.TeamDisbanded
Creates an instance of a TeamDisbanded record class.
teamId() - Method in record class akka.javasdk.agent.autonomous.Notification.TeamCreated
Returns the value of the teamId record component.
teamId() - Method in record class akka.javasdk.agent.autonomous.Notification.TeamDisbanded
Returns the value of the teamId record component.
teamId() - Method in record class akka.javasdk.agent.autonomous.Notification.TeamMemberReady
Returns the value of the teamId record component.
teamId() - Method in record class akka.javasdk.agent.autonomous.Notification.TeamMemberSetupFailed
Returns the value of the teamId record component.
teamId() - Method in record class akka.javasdk.agent.autonomous.Notification.TeamMemberStopped
Returns the value of the teamId record component.
TeamJoined(String, String) - Constructor for record class akka.javasdk.agent.autonomous.Notification.TeamJoined
Creates an instance of a TeamJoined record class.
TeamLeadership - Interface in akka.javasdk.agent.autonomous.capability
Declares that an agent can lead a team of autonomous agents.
TeamLeadership.TeamMember - Interface in akka.javasdk.agent.autonomous.capability
A team member type that can be added to the team.
TeamMemberReady(String, String, String) - Constructor for record class akka.javasdk.agent.autonomous.Notification.TeamMemberReady
Creates an instance of a TeamMemberReady record class.
TeamMemberSetupFailed(String, String, String, String) - Constructor for record class akka.javasdk.agent.autonomous.Notification.TeamMemberSetupFailed
Creates an instance of a TeamMemberSetupFailed record class.
TeamMemberStopped(String, String, String) - Constructor for record class akka.javasdk.agent.autonomous.Notification.TeamMemberStopped
Creates an instance of a TeamMemberStopped record class.
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.AzureOpenAi
Returns the value of the temperature record component.
temperature() - Method in record class akka.javasdk.agent.ModelProvider.Bedrock
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.MistralAi
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.
temperature() - Method in record class akka.javasdk.agent.ModelProvider.VertexAi
Returns the value of the temperature record component.
templateParameterNames() - Method in class akka.javasdk.agent.task.TaskTemplate
Extract parameter names from the template.
terminate() - Method in interface akka.javasdk.client.AutonomousAgentClient
Terminate the agent.
terminate(Class<? extends Workflow<?>>) - Method in interface akka.javasdk.client.WorkflowClient
Terminate the workflow identified by this client's workflow id.
terminate(Class<? extends Workflow<?>>, String) - Method in interface akka.javasdk.client.WorkflowClient
Terminate the workflow identified by this client's workflow id, recording a free-form reason.
terminate(String) - Method in interface akka.javasdk.client.AutonomousAgentClient
Terminate the agent with a reason.
terminateAsync() - Method in interface akka.javasdk.client.AutonomousAgentClient
terminateAsync(Class<? extends Workflow<?>>) - Method in interface akka.javasdk.client.WorkflowClient
terminateAsync(Class<? extends Workflow<?>>, String) - Method in interface akka.javasdk.client.WorkflowClient
terminateAsync(String) - Method in interface akka.javasdk.client.AutonomousAgentClient
text() - Method in record class akka.javasdk.agent.autonomous.Notification.MessageReceived
Returns the value of the text record component.
text() - Method in record class akka.javasdk.agent.MessageContent.TextMessageContent
Returns the value of the text record component.
text() - Method in record class akka.javasdk.agent.SessionMessage.AiMessage
Returns the value of the text record component.
text() - Method in record class akka.javasdk.agent.SessionMessage.MessageContent.TextMessageContent
Returns the value of the text record component.
text() - Method in record class akka.javasdk.agent.SessionMessage.MultimodalUserMessage
returns text from the first MessageContent.TextMessageContent
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.
text() - Method in record class akka.javasdk.agent.task.TaskAttachment
Returns the value of the text record component.
text() - Method in record class akka.javasdk.agent.UserMessage
 
TextGuardrail - Interface in akka.javasdk.agent
Guardrails can protect against harmful inputs and outputs to/from model and tool calls.
TextMessageContent(String) - Constructor for record class akka.javasdk.agent.MessageContent.TextMessageContent
Creates an instance of a TextMessageContent record class.
TextMessageContent(String) - Constructor for record class akka.javasdk.agent.SessionMessage.MessageContent.TextMessageContent
Creates an instance of a TextMessageContent record class.
thenDelete() - Method in interface akka.javasdk.workflow.Workflow.StepEffect.Builder
Finish and delete the workflow execution.
thenDelete() - Method in interface akka.javasdk.workflow.Workflow.StepEffect.PersistenceEffectBuilder
Finish and delete the workflow execution.
thenDelete(String) - Method in interface akka.javasdk.workflow.Workflow.StepEffect.Builder
Finish and delete the workflow execution with a reason description.
thenDelete(String) - Method in interface akka.javasdk.workflow.Workflow.StepEffect.PersistenceEffectBuilder
Finish and delete the workflow execution with a reason description.
thenEnd() - Method in interface akka.javasdk.workflow.Workflow.StepEffect.Builder
Finish the workflow execution.
thenEnd() - Method in interface akka.javasdk.workflow.Workflow.StepEffect.PersistenceEffectBuilder
Finish the workflow execution.
thenEnd(String) - Method in interface akka.javasdk.workflow.Workflow.StepEffect.Builder
Finish the workflow execution with a reason description.
thenEnd(String) - Method in interface akka.javasdk.workflow.Workflow.StepEffect.PersistenceEffectBuilder
Finish the workflow execution with a reason description.
thenPause() - Method in interface akka.javasdk.workflow.Workflow.StepEffect.Builder
Pause the workflow execution and wait for an external input, e.g.
thenPause() - Method in interface akka.javasdk.workflow.Workflow.StepEffect.PersistenceEffectBuilder
Pause the workflow execution and wait for an external input, e.g.
thenPause(Workflow.PauseSettings) - Method in interface akka.javasdk.workflow.Workflow.StepEffect.Builder
Pause the workflow execution with advanced configuration options.
thenPause(Workflow.PauseSettings) - Method in interface akka.javasdk.workflow.Workflow.StepEffect.PersistenceEffectBuilder
Pause the workflow execution with advanced configuration options.
thenPause(String) - Method in interface akka.javasdk.workflow.Workflow.StepEffect.Builder
Pause the workflow execution with a reason description and wait for an external input, e.g.
thenPause(String) - Method in interface akka.javasdk.workflow.Workflow.StepEffect.PersistenceEffectBuilder
Pause the workflow execution with a reason description and wait for an external input, e.g.
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(Supplier<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(R) - Method in interface akka.javasdk.workflow.Workflow.Effect.Transitional
Reply after for example updateState.
thenReply(R, Metadata) - Method in interface akka.javasdk.workflow.Workflow.Effect.Transitional
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.
thenTransitionTo(Function<W, Workflow.StepEffect>) - Method in interface akka.javasdk.workflow.Workflow.StepEffect.Builder
Defines the next step to which the workflow should transition to.
thenTransitionTo(Function<W, Workflow.StepEffect>) - Method in interface akka.javasdk.workflow.Workflow.StepEffect.PersistenceEffectBuilder
Defines the next step to which the workflow should transition to.
thenTransitionTo(Function2<W, I, Workflow.StepEffect>) - Method in interface akka.javasdk.workflow.Workflow.StepEffect.Builder
Defines the next step to which the workflow should transition to.
thenTransitionTo(Function2<W, I, Workflow.StepEffect>) - Method in interface akka.javasdk.workflow.Workflow.StepEffect.PersistenceEffectBuilder
Defines the next step to which the workflow should transition to.
think() - Method in record class akka.javasdk.agent.ModelProvider.Ollama
Returns the value of the think record component.
thinking() - Method in record class akka.javasdk.agent.ModelProvider.HuggingFace
Returns the value of the thinking record component.
thinking() - Method in record class akka.javasdk.agent.ModelProvider.MistralAi
Returns the value of the thinking record component.
thinking() - Method in record class akka.javasdk.agent.ModelProvider.OpenAi
Returns the value of the thinking record component.
thinking() - Method in record class akka.javasdk.agent.SessionMemoryEntity.Event.AiMessageAdded
Returns the value of the thinking record component.
thinking() - Method in record class akka.javasdk.agent.SessionMessage.AiMessage
Returns the value of the thinking record component.
thinkingBudget() - Method in record class akka.javasdk.agent.ModelProvider.GoogleAIGemini
Returns the value of the thinkingBudget record component.
thinkingBudget() - Method in record class akka.javasdk.agent.ModelProvider.VertexAi
Returns the value of the thinkingBudget record component.
thinkingBudgetTokens() - Method in record class akka.javasdk.agent.ModelProvider.Anthropic
Returns the value of the thinkingBudgetTokens record component.
thinkingLevel() - Method in record class akka.javasdk.agent.ModelProvider.GoogleAIGemini
Returns the value of the thinkingLevel record component.
threshold() - Method in class akka.javasdk.agent.SimilarityGuard
 
throwable() - Method in interface akka.javasdk.UnhandledExceptionContext
The original throwable thrown by user code, with its full stack trace and causes.
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() - Method in record class akka.javasdk.workflow.Workflow.PauseSettings
Returns the value of the timeout record component.
timeout() - Method in record class akka.javasdk.workflow.Workflow.PauseSettingsBuilder
Returns the value of the timeout record component.
timeout() - Method in record class akka.javasdk.workflow.Workflow.StepSettings
Returns the value of the timeout record component.
timeout(Duration) - Method in class akka.javasdk.workflow.Workflow.WorkflowSettingsBuilder
Define a timeout for the duration of the entire workflow.
timeout(Duration, Function<W, Workflow.StepEffect>) - Method in class akka.javasdk.workflow.Workflow.WorkflowSettingsBuilder
Define a timeout for the duration of the entire workflow with a timeout handler step.
timeout(Duration, Function2<W, I, Workflow.StepEffect>, I) - Method in class akka.javasdk.workflow.Workflow.WorkflowSettingsBuilder
Define a timeout for the duration of the entire workflow with a timeout handler step that accepts input.
timeoutHandler() - Method in record class akka.javasdk.workflow.Workflow.PauseSettings
Returns the value of the timeoutHandler record component.
timeoutHandler(Function<W, Workflow.Effect<Done>>) - Method in record class akka.javasdk.workflow.Workflow.PauseSettingsBuilder
Configures the handler to be invoked when the pause timeout expires.
timeoutHandler(Function2<W, I, Workflow.Effect<Done>>, I) - Method in record class akka.javasdk.workflow.Workflow.PauseSettingsBuilder
Configures the handler to be invoked when the pause timeout expires.
timers() - Method in class akka.javasdk.consumer.Consumer
Returns a TimerScheduler that can be used to schedule actions to be executed at a later 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.MultimodalUserMessageAdded
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.MultimodalUserMessage
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.
to(Class<? extends AgentDelegationWorker>, Class<? extends AgentDelegationWorker>...) - Static method in interface akka.javasdk.agent.autonomous.capability.Delegation
Create a delegation capability for the given agent targets.
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.
tokenUsage() - Method in record class akka.javasdk.agent.Agent.AgentReply
Returns the value of the tokenUsage record component.
tokenUsage() - Method in record class akka.javasdk.agent.autonomous.Notification.IterationCompleted
Returns the value of the tokenUsage record component.
tokenUsage() - Method in record class akka.javasdk.agent.SessionHistory
Returns the value of the tokenUsage record component.
tokenUsage() - Method in record class akka.javasdk.agent.SessionMemoryEntity.Event.AiMessageAdded
Returns the value of the tokenUsage record component.
tokenUsage() - Method in record class akka.javasdk.agent.SessionMemoryEntity.State
Returns the value of the tokenUsage record component.
tokenUsage() - Method in record class akka.javasdk.agent.SessionMessage.AiMessage
Returns the value of the tokenUsage record component.
TokenUsage(int, int) - Constructor for record class akka.javasdk.agent.Agent.TokenUsage
Creates an instance of a TokenUsage record class.
TokenUsage(int, int) - Constructor for record class akka.javasdk.agent.autonomous.AutonomousAgent.TokenUsage
Creates an instance of a TokenUsage record class.
TokenUsage(int, int) - Constructor for record class akka.javasdk.agent.SessionMessage.TokenUsage
Creates an instance of a TokenUsage record class.
toMap() - Method in interface akka.javasdk.http.QueryParams
Returns a key/value map of the parameters.
toMessageContent() - Method in record class akka.javasdk.agent.task.TaskAttachment
Reconstruct the MessageContent from this reference.
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...) - Method in interface akka.javasdk.agent.autonomous.AgentDefinition
Adds one or more tool instances or classes that the agent can use.
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.
topic() - Method in record class akka.javasdk.agent.autonomous.Notification.ConversationCreated
Returns the value of the topic record component.
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.AzureOpenAi
Returns the value of the topP record component.
topP() - Method in record class akka.javasdk.agent.ModelProvider.Bedrock
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.MistralAi
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.
topP() - Method in record class akka.javasdk.agent.ModelProvider.VertexAi
Returns the value of the topP record component.
toSequenceNr() - Method in record class akka.javasdk.agent.SessionHistoryResult.Truncated
Returns the value of the toSequenceNr record component.
toString() - Method in record class akka.javasdk.agent.Agent.AgentReply
Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.agent.Agent.TokenUsage
Returns a string representation of this record class.
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.autonomous.AutonomousAgent.TokenUsage
Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.agent.autonomous.Notification.Activated
Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.agent.autonomous.Notification.BacklogAccessGranted
Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.agent.autonomous.Notification.BacklogAssigned
Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.agent.autonomous.Notification.BacklogClosed
Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.agent.autonomous.Notification.BacklogTaskClaimed
Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.agent.autonomous.Notification.ContactAdded
Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.agent.autonomous.Notification.ConversationCreated
Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.agent.autonomous.Notification.ConversationEnded
Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.agent.autonomous.Notification.ConversationJoined
Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.agent.autonomous.Notification.ConversationParticipantReady
Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.agent.autonomous.Notification.ConversationParticipantSetupFailed
Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.agent.autonomous.Notification.ConversationTurnReceived
Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.agent.autonomous.Notification.Deactivated
Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.agent.autonomous.Notification.DelegationResolved
Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.agent.autonomous.Notification.DelegationStarted
Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.agent.autonomous.Notification.DependencyResolved
Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.agent.autonomous.Notification.HandoffReceived
Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.agent.autonomous.Notification.HandoffStarted
Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.agent.autonomous.Notification.IterationCompleted
Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.agent.autonomous.Notification.IterationFailed
Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.agent.autonomous.Notification.IterationStarted
Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.agent.autonomous.Notification.MessageReceived
Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.agent.autonomous.Notification.ParticipantTurnSubmitted
Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.agent.autonomous.Notification.RepeatedIterationFailure
Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.agent.autonomous.Notification.Resumed
Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.agent.autonomous.Notification.Stopped
Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.agent.autonomous.Notification.Suspended
Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.agent.autonomous.Notification.TaskApproachingMaxIterations
Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.agent.autonomous.Notification.TaskAssigned
Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.agent.autonomous.Notification.TaskCancelled
Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.agent.autonomous.Notification.TaskCompleted
Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.agent.autonomous.Notification.TaskDependencyStuck
Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.agent.autonomous.Notification.TaskDependencyWait
Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.agent.autonomous.Notification.TaskFailed
Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.agent.autonomous.Notification.TaskResultRejected
Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.agent.autonomous.Notification.TaskStarted
Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.agent.autonomous.Notification.TaskStruggleDetected
Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.agent.autonomous.Notification.TeamCreated
Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.agent.autonomous.Notification.TeamDisbanded
Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.agent.autonomous.Notification.TeamJoined
Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.agent.autonomous.Notification.TeamMemberReady
Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.agent.autonomous.Notification.TeamMemberSetupFailed
Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.agent.autonomous.Notification.TeamMemberStopped
Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.agent.autonomous.Notification.WorkerTaskCompleted
Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.agent.autonomous.Notification.WorkerTaskReceived
Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.agent.ContentLoader.LoadedContent
Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.agent.evaluator.HallucinationEvaluator.EvaluationRequest
Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.agent.evaluator.HallucinationEvaluator.Result
Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.agent.evaluator.SummarizationEvaluator.EvaluationRequest
Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.agent.evaluator.SummarizationEvaluator.Result
Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.agent.evaluator.ToxicityEvaluator.Result
Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.agent.Guardrail.Result
Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.agent.ImageLoader.LoadedImage
Deprecated.
Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.agent.MemoryFilter.Exclude
Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.agent.MemoryFilter.Include
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.MessageContent.ImageMessageContent
Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.agent.MessageContent.ImageUrlMessageContent
Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.agent.MessageContent.PdfMessageContent
Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.agent.MessageContent.PdfUrlMessageContent
Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.agent.MessageContent.TextMessageContent
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.AzureOpenAi
Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.agent.ModelProvider.Bedrock
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.MistralAi
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.ModelProvider.VertexAi
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.SessionHistoryResult.Loaded
Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.agent.SessionHistoryResult.Truncated
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.AddMultimodalInteractionCmd
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.MultimodalUserMessageAdded
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.MessageContent.ImageUriMessageContent
Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.agent.SessionMessage.MessageContent.PdfUriMessageContent
Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.agent.SessionMessage.MessageContent.TextMessageContent
Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.agent.SessionMessage.MultimodalUserMessage
Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.agent.SessionMessage.TokenUsage
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.agent.task.TaskAttachment
Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.agent.task.TaskEntity.CreateRequest
Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.agent.task.TaskEntity.ReassignRequest
Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.agent.task.TaskEntity.RejectResultRequest
Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.agent.task.TaskEvent.TaskAssigned
Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.agent.task.TaskEvent.TaskCancelled
Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.agent.task.TaskEvent.TaskCompleted
Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.agent.task.TaskEvent.TaskCreated
Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.agent.task.TaskEvent.TaskFailed
Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.agent.task.TaskEvent.TaskReassigned
Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.agent.task.TaskEvent.TaskResultRejected
Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.agent.task.TaskEvent.TaskStarted
Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.agent.task.TaskKey
Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.agent.task.TaskNotification.Cancelled
Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.agent.task.TaskNotification.Completed
Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.agent.task.TaskNotification.Failed
Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.agent.task.TaskNotification.ResultRejected
Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.agent.task.TaskRule.Result.Accepted
Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.agent.task.TaskRule.Result.Rejected
Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.agent.task.TaskSnapshot
Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.agent.task.TaskState
Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.agent.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.DataMessageContentImpl.Image
Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.impl.agent.DataMessageContentImpl.Pdf
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 record class akka.javasdk.impl.agent.task.BacklogEntity.ClaimRequest
Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.impl.agent.task.BacklogEntity.TransferRequest
Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.impl.agent.task.BacklogEvent.BacklogClosed
Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.impl.agent.task.BacklogEvent.BacklogCreated
Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.impl.agent.task.BacklogEvent.TaskAdded
Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.impl.agent.task.BacklogEvent.TaskClaimed
Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.impl.agent.task.BacklogEvent.TaskReleased
Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.impl.agent.task.BacklogEvent.TaskTransferred
Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.impl.agent.task.BacklogEvent.UnclaimedCancelled
Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.impl.agent.task.BacklogNotification.BacklogClosed
Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.impl.agent.task.BacklogNotification.BacklogCreated
Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.impl.agent.task.BacklogNotification.TaskAdded
Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.impl.agent.task.BacklogNotification.TaskClaimed
Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.impl.agent.task.BacklogNotification.TaskReleased
Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.impl.agent.task.BacklogNotification.TaskTransferred
Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.impl.agent.task.BacklogNotification.UnclaimedCancelled
Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.impl.agent.task.BacklogState.Entry
Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.impl.agent.task.BacklogState
Returns a string representation of this record class.
toString() - Method in class akka.javasdk.Principal.LocalService
 
toString() - Method in record class akka.javasdk.view.EntryWithMetadata
Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.workflow.Workflow.CommandHandler.NoArgCommandHandler
Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.workflow.Workflow.CommandHandler.OneArgCommandHandler
Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.workflow.Workflow.PauseSettings
Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.workflow.Workflow.PauseSettingsBuilder
Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.workflow.Workflow.RecoverStrategy.MaxRetries
Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.workflow.Workflow.RecoverStrategy.RecoveryInput
Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.workflow.Workflow.RecoverStrategy
Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.workflow.Workflow.StepHandler.NoArgStepHandler
Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.workflow.Workflow.StepHandler.OneArgStepHandler
Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.workflow.Workflow.StepMethod
Returns a string representation of this record class.
toString() - Method in record class akka.javasdk.workflow.Workflow.StepSettings
Returns a string representation of this record class.
totalTokenUsage() - Method in class akka.javasdk.agent.autonomous.AgentState
Total token usage for this agent instance.
ToxicityEvaluator - Class in akka.javasdk.agent.evaluator
An agent that acts as an LLM judge to evaluate if an AI response or other text is racist, biased, or toxic.
ToxicityEvaluator(ComponentClient, Config) - Constructor for class akka.javasdk.agent.evaluator.ToxicityEvaluator
 
ToxicityEvaluator.Result - Record Class in akka.javasdk.agent.evaluator
 
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.
transfer(BacklogEntity.TransferRequest) - Method in class akka.javasdk.impl.agent.task.BacklogEntity
Transfer a claimed task directly to a different agent.
transferredTo() - Method in record class akka.javasdk.impl.agent.task.BacklogEntity.TransferRequest
Returns the value of the transferredTo record component.
transferredTo() - Method in record class akka.javasdk.impl.agent.task.BacklogEvent.TaskTransferred
Returns the value of the transferredTo record component.
transferredTo() - Method in record class akka.javasdk.impl.agent.task.BacklogNotification.TaskTransferred
Returns the value of the transferredTo record component.
TransferRequest(String, String) - Constructor for record class akka.javasdk.impl.agent.task.BacklogEntity.TransferRequest
Creates an instance of a TransferRequest record class.
transform(int, JsonNode) - Method in class akka.javasdk.JsonMigration
Implement the transformation of the incoming JSON structure to the current JSON structure.
transitionTo(Function<W, Workflow.StepEffect>) - Method in interface akka.javasdk.workflow.Workflow.Effect.Builder
Defines the next step to which the workflow should transition to.
transitionTo(Function<W, Workflow.StepEffect>) - Method in interface akka.javasdk.workflow.Workflow.Effect.PersistenceEffectBuilder
Defines the next step to which the workflow should transition to.
transitionTo(Function2<W, I, Workflow.StepEffect>) - Method in interface akka.javasdk.workflow.Workflow.Effect.Builder
Defines the next step to which the workflow should transition to.
transitionTo(Function2<W, I, Workflow.StepEffect>) - Method in interface akka.javasdk.workflow.Workflow.Effect.PersistenceEffectBuilder
Defines the next step to which the workflow should transition to.
truncated() - Method in record class akka.javasdk.agent.SessionMemoryEntity.State
Returns the value of the truncated record component.
Truncated(long, long) - Constructor for record class akka.javasdk.agent.SessionHistoryResult.Truncated
Creates an instance of a Truncated record class.
type() - Method in record class akka.javasdk.agent.task.TaskAttachment
Returns the value of the type record component.
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

ULTRA_HIGH - Enum constant in enum class akka.javasdk.agent.MessageContent.ImageMessageContent.DetailLevel
Ultra-high resolution processing, highest token count.
unauthorized() - Static method in class akka.javasdk.http.HttpException
 
unauthorized(String) - Static method in class akka.javasdk.http.HttpException
 
UnclaimedCancelled() - Constructor for record class akka.javasdk.impl.agent.task.BacklogEvent.UnclaimedCancelled
Creates an instance of a UnclaimedCancelled record class.
UnclaimedCancelled() - Constructor for record class akka.javasdk.impl.agent.task.BacklogNotification.UnclaimedCancelled
Creates an instance of a UnclaimedCancelled record class.
unclaimedTaskIds() - Method in record class akka.javasdk.impl.agent.task.BacklogState
 
UnhandledExceptionContext - Interface in akka.javasdk
Information about an exception thrown by user code that the runtime caught and turned into a generic 500 response with a correlation id.
UnhandledExceptionHandler - Interface in akka.javasdk
Mix-in interface that can be implemented alongside ServiceSetup on a class annotated with Setup to be notified when the runtime catches an exception thrown by user code from a component or endpoint.
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.
updateReplicationFilter(ReplicationFilter.Builder) - Method in interface akka.javasdk.eventsourcedentity.EventSourcedEntity.Effect.Builder
Change the replication filter for this entity without persisting any events.
updateReplicationFilter(ReplicationFilter.Builder) - Method in interface akka.javasdk.eventsourcedentity.EventSourcedEntity.Effect.OnSuccessBuilder
Change the replication filter for this entity, combined with persisting events.
updateReplicationFilter(ReplicationFilter.Builder) - Method in interface akka.javasdk.keyvalueentity.KeyValueEntity.Effect.Builder
Change the replication filter for this entity updating the state.
updateReplicationFilter(ReplicationFilter.Builder) - Method in interface akka.javasdk.keyvalueentity.KeyValueEntity.Effect.OnSuccessBuilder
Change the replication filter for this entity, combined with updating state.
updateRow(S) - Method in interface akka.javasdk.view.TableUpdater.Effect.Builder
Updates the state of view row.
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
 
updateState(S) - Method in interface akka.javasdk.workflow.Workflow.StepEffect.Builder
 
updateStateWithMetadata(S, Metadata) - Method in interface akka.javasdk.keyvalueentity.KeyValueEntity.Effect.Builder
Updates the entity state with the provided new state and additional metadata together with the state.
uri() - Method in record class akka.javasdk.agent.MessageContent.ImageUrlMessageContent
Returns the value of the uri record component.
uri() - Method in record class akka.javasdk.agent.MessageContent.PdfUrlMessageContent
Returns the value of the uri record component.
uri() - Method in record class akka.javasdk.agent.SessionMessage.MessageContent.ImageUriMessageContent
Returns the value of the uri record component.
uri() - Method in record class akka.javasdk.agent.SessionMessage.MessageContent.PdfUriMessageContent
Returns the value of the uri record component.
uri() - Method in record class akka.javasdk.agent.task.TaskAttachment
Returns the value of the uri record component.
uri() - Element in annotation interface akka.javasdk.annotations.mcp.McpResource
 
uriTemplate() - Element in annotation interface akka.javasdk.annotations.mcp.McpResource
 
url() - Method in record class akka.javasdk.agent.MessageContent.ImageUrlMessageContent
Deprecated, for removal: This API element is subject to removal in a future version.
url() - Method in record class akka.javasdk.agent.MessageContent.PdfUrlMessageContent
Deprecated, for removal: This API element is subject to removal in a future version.
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.AddMultimodalInteractionCmd
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(UserMessage) - Method in interface akka.javasdk.agent.Agent.Effect.Builder
The user message to the AI model, supporting multimodal content.
userMessage(UserMessage) - Method in interface akka.javasdk.agent.Agent.StreamEffect.Builder
The user message to the AI model, supporting multimodal content.
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 - Record Class in akka.javasdk.agent
Represents a user message that can contain multimodal content for interaction with AI models.
UserMessage(Instant, String) - Constructor for record class akka.javasdk.agent.SessionMessage.UserMessage
 
UserMessage(Instant, String, String) - Constructor for record class akka.javasdk.agent.SessionMessage.UserMessage
Creates an instance of a UserMessage record class.
UserMessage(List<MessageContent>) - Constructor for record class akka.javasdk.agent.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.Agent.AgentReply
Returns the value of the value record component.
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.AgentRole
The role of the agent.
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.http.WebSocket
 
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.ProtoEventTypes
The protobuf message classes used as event types.
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.StepName
A workflow step name
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.agent.MessageContent.ImageMessageContent.DetailLevel
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class akka.javasdk.agent.ModelProvider.BedrockPromptCachePlacement
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class akka.javasdk.agent.task.TaskStatus
Returns the enum constant of this class with the specified name.
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.agent.MessageContent.ImageMessageContent.DetailLevel
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class akka.javasdk.agent.ModelProvider.BedrockPromptCachePlacement
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class akka.javasdk.agent.task.TaskStatus
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.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.
vertexAi() - Static method in interface akka.javasdk.agent.ModelProvider
Settings for the Google Cloud Vertex AI Large Language Model provider.
VertexAi(String, String, String, String, String, String, double, double, int, int, Duration, Duration, int, List<HttpHeader>) - Constructor for record class akka.javasdk.agent.ModelProvider.VertexAi
Creates an instance of a VertexAi record class.
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
ViewStreamMethodRef<R> - Interface in akka.javasdk.client
Zero argument component call representation, query is not executed until stream is materialized.
ViewStreamMethodRef1<A1,R> - Interface in akka.javasdk.client
One argument streaming view query representation, the query is not executed until stream is materialized.

W

waitDurationSeconds() - Method in record class akka.javasdk.agent.autonomous.Notification.TaskDependencyStuck
Returns the value of the waitDurationSeconds record component.
WebSocket - Annotation Interface in akka.javasdk.annotations.http
Annotation to mark an endpoint method as handling HTTP WebSocket upgrade requests.
withAccessToken(String) - Method in record class akka.javasdk.agent.ModelProvider.Bedrock
 
withAccessToken(String) - Method in record class akka.javasdk.agent.ModelProvider.HuggingFace
 
withAdditionalModelRequestFields(Map<String, Object>) - Method in record class akka.javasdk.agent.ModelProvider.Bedrock
 
withAdditionalModelRequestHeaders(List<HttpHeader>) - Method in record class akka.javasdk.agent.ModelProvider.Anthropic
 
withAdditionalModelRequestHeaders(List<HttpHeader>) - Method in record class akka.javasdk.agent.ModelProvider.AzureOpenAi
 
withAdditionalModelRequestHeaders(List<HttpHeader>) - Method in record class akka.javasdk.agent.ModelProvider.Bedrock
 
withAdditionalModelRequestHeaders(List<HttpHeader>) - Method in record class akka.javasdk.agent.ModelProvider.GoogleAIGemini
 
withAdditionalModelRequestHeaders(List<HttpHeader>) - Method in record class akka.javasdk.agent.ModelProvider.HuggingFace
 
withAdditionalModelRequestHeaders(List<HttpHeader>) - Method in record class akka.javasdk.agent.ModelProvider.LocalAI
 
withAdditionalModelRequestHeaders(List<HttpHeader>) - Method in record class akka.javasdk.agent.ModelProvider.MistralAi
 
withAdditionalModelRequestHeaders(List<HttpHeader>) - Method in record class akka.javasdk.agent.ModelProvider.Ollama
 
withAdditionalModelRequestHeaders(List<HttpHeader>) - Method in record class akka.javasdk.agent.ModelProvider.OpenAi
 
withAdditionalModelRequestHeaders(List<HttpHeader>) - Method in record class akka.javasdk.agent.ModelProvider.VertexAi
 
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.AzureOpenAi
 
withApiKey(String) - Method in record class akka.javasdk.agent.ModelProvider.GoogleAIGemini
 
withApiKey(String) - Method in record class akka.javasdk.agent.ModelProvider.MistralAi
 
withApiKey(String) - Method in record class akka.javasdk.agent.ModelProvider.OpenAi
 
withApiKey(String) - Method in record class akka.javasdk.agent.ModelProvider.VertexAi
 
withApiVersion(String) - Method in record class akka.javasdk.agent.ModelProvider.VertexAi
 
withAssignee(String) - Method in record class akka.javasdk.agent.task.TaskState
 
withBaseUrl(String) - Method in record class akka.javasdk.agent.ModelProvider.Anthropic
 
withBaseUrl(String) - Method in record class akka.javasdk.agent.ModelProvider.GoogleAIGemini
 
withBaseUrl(String) - Method in record class akka.javasdk.agent.ModelProvider.HuggingFace
 
withBaseUrl(String) - Method in record class akka.javasdk.agent.ModelProvider.MistralAi
 
withBaseUrl(String) - Method in record class akka.javasdk.agent.ModelProvider.Ollama
 
withBaseUrl(String) - Method in record class akka.javasdk.agent.ModelProvider.OpenAi
 
withBaseUrl(String) - Method in record class akka.javasdk.agent.ModelProvider.VertexAi
 
withCacheSystemMessages(boolean) - Method in record class akka.javasdk.agent.ModelProvider.Anthropic
 
withCacheTools(boolean) - Method in record class akka.javasdk.agent.ModelProvider.Anthropic
 
withCancellation(String) - Method in record class akka.javasdk.agent.task.TaskState
 
withClosed() - Method in record class akka.javasdk.impl.agent.task.BacklogState
 
withConnectionTimeout(Duration) - Method in record class akka.javasdk.agent.ModelProvider.Anthropic
 
withConnectionTimeout(Duration) - Method in record class akka.javasdk.agent.ModelProvider.AzureOpenAi
 
withConnectionTimeout(Duration) - Method in record class akka.javasdk.agent.ModelProvider.GoogleAIGemini
 
withConnectionTimeout(Duration) - Method in record class akka.javasdk.agent.ModelProvider.HuggingFace
 
withConnectionTimeout(Duration) - Method in record class akka.javasdk.agent.ModelProvider.MistralAi
 
withConnectionTimeout(Duration) - Method in record class akka.javasdk.agent.ModelProvider.Ollama
 
withConnectionTimeout(Duration) - Method in record class akka.javasdk.agent.ModelProvider.OpenAi
 
withConnectionTimeout(Duration) - Method in record class akka.javasdk.agent.ModelProvider.VertexAi
 
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.
withDeploymentName(String) - Method in record class akka.javasdk.agent.ModelProvider.AzureOpenAi
 
withDetailedReply() - Method in interface akka.javasdk.client.AgentInvokeOnlyMethodRef
Switch to a detailed reply mode that includes e.g.
withDetailedReply() - Method in interface akka.javasdk.client.AgentInvokeOnlyMethodRef1
Switch to a detailed reply mode that includes e.g.
withDetailedReply() - Method in interface akka.javasdk.client.AgentMethodRef
Switch to a detailed reply mode that includes e.g.
withDetailedReply() - Method in interface akka.javasdk.client.AgentMethodRef1
Switch to a detailed reply mode that includes e.g.
withEndpoint(String) - Method in record class akka.javasdk.agent.ModelProvider.AzureOpenAi
 
withEntry(O) - Method in record class akka.javasdk.view.EntryWithMetadata
Create a new view entry with the same metadata.
withFailure(String) - Method in record class akka.javasdk.agent.task.TaskState
 
withFrequencyPenalty(double) - Method in record class akka.javasdk.agent.ModelProvider.AzureOpenAi
 
withFrequencyPenalty(double) - Method in record class akka.javasdk.agent.ModelProvider.MistralAi
 
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.
withInput(I) - Method in record class akka.javasdk.workflow.Workflow.RecoverStrategy.RecoveryInput
 
withInput(I) - Method in interface akka.javasdk.workflow.Workflow.WithInput
 
withInterceptor(SessionMemoryInterceptor) - Method in interface akka.javasdk.agent.MemoryProvider
Wraps this provider with a SessionMemoryInterceptor that intercepts addInteraction calls.
withLocation(String) - Method in record class akka.javasdk.agent.ModelProvider.VertexAi
 
withMaxCompletionTokens(int) - Method in record class akka.javasdk.agent.ModelProvider.AzureOpenAi
 
withMaxCompletionTokens(int) - Method in record class akka.javasdk.agent.ModelProvider.OpenAi
 
withMaxNewTokens(Integer) - Method in record class akka.javasdk.agent.ModelProvider.HuggingFace
 
withMaxOutputTokens(int) - Method in record class akka.javasdk.agent.ModelProvider.Bedrock
 
withMaxOutputTokens(int) - Method in record class akka.javasdk.agent.ModelProvider.GoogleAIGemini
 
withMaxOutputTokens(int) - Method in record class akka.javasdk.agent.ModelProvider.VertexAi
 
withMaxRetries(int) - Method in record class akka.javasdk.agent.ModelProvider.Anthropic
 
withMaxRetries(int) - Method in record class akka.javasdk.agent.ModelProvider.AzureOpenAi
 
withMaxRetries(int) - Method in record class akka.javasdk.agent.ModelProvider.Bedrock
 
withMaxRetries(int) - Method in record class akka.javasdk.agent.ModelProvider.GoogleAIGemini
 
withMaxRetries(int) - Method in record class akka.javasdk.agent.ModelProvider.HuggingFace
 
withMaxRetries(int) - Method in record class akka.javasdk.agent.ModelProvider.MistralAi
 
withMaxRetries(int) - Method in record class akka.javasdk.agent.ModelProvider.Ollama
 
withMaxRetries(int) - Method in record class akka.javasdk.agent.ModelProvider.OpenAi
 
withMaxRetries(int) - Method in record class akka.javasdk.agent.ModelProvider.VertexAi
 
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.AzureOpenAi
 
withMaxTokens(int) - Method in record class akka.javasdk.agent.ModelProvider.Bedrock
 
withMaxTokens(int) - Method in record class akka.javasdk.agent.ModelProvider.LocalAI
 
withMaxTokens(int) - Method in record class akka.javasdk.agent.ModelProvider.MistralAi
 
withMaxTokens(int) - Method in record class akka.javasdk.agent.ModelProvider.OpenAi
 
withMetadata(Metadata) - Method in interface akka.javasdk.client.AgentMethodRef
 
withMetadata(Metadata) - Method in interface akka.javasdk.client.AgentMethodRef1
 
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.Bedrock
 
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.MistralAi
 
withModelName(String) - Method in record class akka.javasdk.agent.ModelProvider.Ollama
 
withModelName(String) - Method in record class akka.javasdk.agent.ModelProvider.OpenAi
 
withModelName(String) - Method in record class akka.javasdk.agent.ModelProvider.VertexAi
 
withName(String) - Method in record class akka.javasdk.impl.agent.task.BacklogState
 
withPresencePenalty(double) - Method in record class akka.javasdk.agent.ModelProvider.AzureOpenAi
 
withPresencePenalty(double) - Method in record class akka.javasdk.agent.ModelProvider.MistralAi
 
withProjectId(String) - Method in record class akka.javasdk.agent.ModelProvider.VertexAi
 
withPromptCaching(ModelProvider.BedrockPromptCachePlacement) - Method in record class akka.javasdk.agent.ModelProvider.Bedrock
 
withRandomSeed(int) - Method in record class akka.javasdk.agent.ModelProvider.MistralAi
 
withReasoningEffort(String) - Method in record class akka.javasdk.agent.ModelProvider.AzureOpenAi
 
withReasoningTokenBudget(int) - Method in record class akka.javasdk.agent.ModelProvider.Bedrock
 
withReassignment(String, String) - Method in record class akka.javasdk.agent.task.TaskState
 
withRecovery(Workflow.RecoverStrategy<?>, Object) - Method in record class akka.javasdk.workflow.Workflow.StepSettings
 
withRegion(String) - Method in record class akka.javasdk.agent.ModelProvider.Bedrock
 
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.
withResponseTimeout(Duration) - Method in record class akka.javasdk.agent.ModelProvider.Anthropic
 
withResponseTimeout(Duration) - Method in record class akka.javasdk.agent.ModelProvider.AzureOpenAi
 
withResponseTimeout(Duration) - Method in record class akka.javasdk.agent.ModelProvider.Bedrock
 
withResponseTimeout(Duration) - Method in record class akka.javasdk.agent.ModelProvider.GoogleAIGemini
 
withResponseTimeout(Duration) - Method in record class akka.javasdk.agent.ModelProvider.HuggingFace
 
withResponseTimeout(Duration) - Method in record class akka.javasdk.agent.ModelProvider.MistralAi
 
withResponseTimeout(Duration) - Method in record class akka.javasdk.agent.ModelProvider.Ollama
 
withResponseTimeout(Duration) - Method in record class akka.javasdk.agent.ModelProvider.OpenAi
 
withResponseTimeout(Duration) - Method in record class akka.javasdk.agent.ModelProvider.VertexAi
 
withResult(String) - Method in record class akka.javasdk.agent.task.TaskState
 
withResultRejection(String) - Method in record class akka.javasdk.agent.task.TaskState
 
withRetry(int) - Method in interface akka.javasdk.client.AgentMethodRef
Set the retry settings for this call.
withRetry(int) - Method in interface akka.javasdk.client.AgentMethodRef1
Set the retry settings for this call.
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.AgentMethodRef
Set the retry settings for this call.
withRetry(RetrySettings) - Method in interface akka.javasdk.client.AgentMethodRef1
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.
withReturnThinking(Boolean) - Method in record class akka.javasdk.agent.ModelProvider.Bedrock
 
withSafePrompt(boolean) - Method in record class akka.javasdk.agent.ModelProvider.MistralAi
 
withSeed(long) - Method in record class akka.javasdk.agent.ModelProvider.AzureOpenAi
 
withSendThinking(Boolean) - Method in record class akka.javasdk.agent.ModelProvider.Bedrock
 
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.
withServiceVersion(String) - Method in record class akka.javasdk.agent.ModelProvider.AzureOpenAi
 
withSource(URI) - Method in interface akka.javasdk.CloudEvent
Return a new CloudEvent with the given source.
withStatus(TaskStatus) - Method in record class akka.javasdk.agent.task.TaskState
 
withStop(List<String>) - Method in record class akka.javasdk.agent.ModelProvider.AzureOpenAi
 
withStopSequences(List<String>) - Method in record class akka.javasdk.agent.ModelProvider.MistralAi
 
withSubject(String) - Method in interface akka.javasdk.CloudEvent
Return a new CloudEvent with the given subject.
withTaskAdded(String) - Method in record class akka.javasdk.impl.agent.task.BacklogState
 
withTaskClaimed(String, String) - Method in record class akka.javasdk.impl.agent.task.BacklogState
 
withTaskReleased(String) - Method in record class akka.javasdk.impl.agent.task.BacklogState
 
withTemperature(double) - Method in record class akka.javasdk.agent.ModelProvider.Anthropic
 
withTemperature(double) - Method in record class akka.javasdk.agent.ModelProvider.AzureOpenAi
 
withTemperature(double) - Method in record class akka.javasdk.agent.ModelProvider.Bedrock
 
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.MistralAi
 
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.VertexAi
 
withTemperature(Double) - Method in record class akka.javasdk.agent.ModelProvider.HuggingFace
 
withThink(boolean) - Method in record class akka.javasdk.agent.ModelProvider.Ollama
 
withThinking(boolean) - Method in record class akka.javasdk.agent.ModelProvider.HuggingFace
 
withThinking(boolean) - Method in record class akka.javasdk.agent.ModelProvider.MistralAi
 
withThinking(boolean) - Method in record class akka.javasdk.agent.ModelProvider.OpenAi
 
withThinkingBudget(int) - Method in record class akka.javasdk.agent.ModelProvider.VertexAi
 
withThinkingBudget(Optional<Integer>) - Method in record class akka.javasdk.agent.ModelProvider.GoogleAIGemini
 
withThinkingBudgetTokens(int) - Method in record class akka.javasdk.agent.ModelProvider.Anthropic
 
withThinkingLevel(String) - Method in record class akka.javasdk.agent.ModelProvider.GoogleAIGemini
 
withTime(ZonedDateTime) - Method in interface akka.javasdk.CloudEvent
Return a new CloudEvent with the given time.
withTimeout(Duration) - Method in interface akka.javasdk.agent.RemoteMcpTools
 
withTimeout(Duration) - Method in interface akka.javasdk.http.RequestBuilder
 
withTimeout(Duration) - Method in record class akka.javasdk.workflow.Workflow.StepSettings
 
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.AzureOpenAi
 
withTopP(double) - Method in record class akka.javasdk.agent.ModelProvider.Bedrock
 
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.MistralAi
 
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.VertexAi
 
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.
withUnclaimedRemoved() - Method in record class akka.javasdk.impl.agent.task.BacklogState
 
workerComponentIds() - Method in record class akka.javasdk.agent.autonomous.Notification.DelegationStarted
Returns the value of the workerComponentIds record component.
workerInstanceIds() - Method in record class akka.javasdk.agent.autonomous.Notification.DelegationStarted
Returns the value of the workerInstanceIds record component.
WorkerTaskCompleted(String) - Constructor for record class akka.javasdk.agent.autonomous.Notification.WorkerTaskCompleted
Creates an instance of a WorkerTaskCompleted record class.
WorkerTaskReceived(String, String, String) - Constructor for record class akka.javasdk.agent.autonomous.Notification.WorkerTaskReceived
Creates an instance of a WorkerTaskReceived record class.
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.CommandHandler - Interface in akka.javasdk.workflow
 
Workflow.CommandHandler.NoArgCommandHandler - Record Class in akka.javasdk.workflow
 
Workflow.CommandHandler.OneArgCommandHandler - Record 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.Transitional - Interface in akka.javasdk.workflow
 
Workflow.PauseSettings - Record Class in akka.javasdk.workflow
 
Workflow.PauseSettingsBuilder - Record Class in akka.javasdk.workflow
 
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> - Record Class in akka.javasdk.workflow
 
Workflow.RecoverStrategy.MaxRetries - Record Class in akka.javasdk.workflow
Retry strategy without failover configuration
Workflow.RecoverStrategy.RecoveryInput<I> - Record Class in akka.javasdk.workflow
 
Workflow.StepEffect - Interface in akka.javasdk.workflow
 
Workflow.StepEffect.Builder<S> - Interface in akka.javasdk.workflow
Construct the step effect that is returned by step method.
Workflow.StepEffect.PersistenceEffectBuilder - Interface in akka.javasdk.workflow
 
Workflow.StepHandler - Interface in akka.javasdk.workflow
 
Workflow.StepHandler.NoArgStepHandler - Record Class in akka.javasdk.workflow
 
Workflow.StepHandler.OneArgStepHandler - Record Class in akka.javasdk.workflow
 
Workflow.StepMethod - Record Class in akka.javasdk.workflow
 
Workflow.StepSettings - Record Class in akka.javasdk.workflow
 
Workflow.WithInput<I,R> - Interface in akka.javasdk.workflow
Represents an operation that accepts an input of type I and produces a result of type R.
Workflow.WorkflowSettings - Interface in akka.javasdk.workflow
 
Workflow.WorkflowSettingsBuilder - 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.
workflowRecoverStrategy() - Method in interface akka.javasdk.workflow.Workflow.WorkflowSettings
 
WorkflowSettingsBuilder(Optional<Duration>, Optional<Workflow.RecoverStrategy<?>>, Map<String, Workflow.StepSettings>, Optional<Duration>, Optional<Duration>, Optional<Workflow.RecoverStrategy<?>>) - Constructor for class akka.javasdk.workflow.Workflow.WorkflowSettingsBuilder
 
workflowTimeout() - Method in interface akka.javasdk.workflow.Workflow.WorkflowSettings
 
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|Constant Field Values|Serialized Form