Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- 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.
- Acl - Annotation Interface in akka.javasdk.annotations
-
Defines ACL configuration for a resource.
- Acl.DenyStatusCode - Enum Class in akka.javasdk.annotations
- Acl.Matcher - Annotation Interface in akka.javasdk.annotations
-
A principal matcher that can be used in an ACL.
- Acl.Principal - Enum Class in akka.javasdk.annotations
-
This enum contains principal matchers that don't have any configuration, such as a name, associated with them, for ease of reference in annotations.
- add(String, String) - Method in interface akka.javasdk.Metadata
-
Add the string value for the given key.
- addBinary(String, ByteBuffer) - Method in interface akka.javasdk.Metadata
-
Add the binary value for the given key.
- addCredentials(HttpCredentials) - Method in interface akka.javasdk.http.RequestBuilder
- addCustomDataToJsonMap(Map<String, Object>, ILoggingEvent) - Method in class akka.javasdk.logging.LogbackJsonLayout
- addHeader(HttpHeader) - Method in interface akka.javasdk.http.RequestBuilder
- addHeader(String, String) - Method in interface akka.javasdk.http.RequestBuilder
- addStep(Workflow.Step) - Method in class akka.javasdk.workflow.Workflow.WorkflowDef
-
Add step to workflow definition.
- addStep(Workflow.Step, Workflow.RecoverStrategy<?>) - Method in class akka.javasdk.workflow.Workflow.WorkflowDef
-
Add step to workflow definition with a dedicated
Workflow.RecoverStrategy
. - akka.javasdk - package akka.javasdk
-
Root package of the Akka SDK.
- akka.javasdk.annotations - package akka.javasdk.annotations
-
Annotations
- akka.javasdk.annotations.http - package akka.javasdk.annotations.http
-
Annotations for
HttpEndpoint
- 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
-
EventSourcedEntity
component. - akka.javasdk.http - package akka.javasdk.http
-
HTTP Endpoint component and HTTP client.
- akka.javasdk.impl - package akka.javasdk.impl
-
Internal implementation classes for Akka SDK.
- akka.javasdk.keyvalueentity - package akka.javasdk.keyvalueentity
-
KeyValueEntity
component. - akka.javasdk.logging - package akka.javasdk.logging
- 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.
- 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.
- andThen(Class<CallOutput>, Function<CallOutput, Workflow.Effect.TransitionalEffect<Void>>) - Method in class akka.javasdk.workflow.StepBuilder.AsyncCallStepBuilder
-
Transition to the next step based on the result of the step call.
- andThen(Class<DefCallOutput>, Function<DefCallOutput, Workflow.Effect.TransitionalEffect<Void>>) - Method in class akka.javasdk.workflow.StepBuilder.CallStepBuilder
-
Transition to the next step based on the result of the step call.
- applyEvent(E) - Method in class akka.javasdk.eventsourcedentity.EventSourcedEntity
-
This is the main event handler method.
- 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.
- asOpenTelemetryContext() - Method in interface akka.javasdk.TraceContext
-
Allows retrieving the trace context as an OpenTelemetry context for easier construction of child spans.
- asyncCall(Class<Input>, Function<Input, CompletionStage<Output>>) - Method in class akka.javasdk.workflow.StepBuilder
-
Build a step action with an async call.
- asyncCall(Supplier<CompletionStage<Output>>) - Method in class akka.javasdk.workflow.StepBuilder
-
Build a step action with an async call.
- AsyncCallStep(String, Class<CallInput>, Function<CallInput, CompletionStage<CallOutput>>, Class<CallOutput>, Function<CallOutput, Workflow.Effect.TransitionalEffect<Void>>) - Constructor for class akka.javasdk.workflow.Workflow.AsyncCallStep
- AsyncCallStepBuilder(String, Class<CallInput>, Function<CallInput, CompletionStage<CallOutput>>) - Constructor for class akka.javasdk.workflow.StepBuilder.AsyncCallStepBuilder
- asyncDone(CompletionStage<Done>) - Method in interface akka.javasdk.consumer.Consumer.Effect.Builder
-
Mark message as processed from an async operation result
- asyncDone(CompletionStage<Done>) - Method in interface akka.javasdk.timedaction.TimedAction.Effect.Builder
-
Command was processed successfully from an async operation result
- asyncEffect(CompletionStage<Consumer.Effect>) - Method in interface akka.javasdk.consumer.Consumer.Effect.Builder
-
Create an async operation result returning an effect.
- asyncEffect(CompletionStage<TimedAction.Effect>) - Method in interface akka.javasdk.timedaction.TimedAction.Effect.Builder
-
Create a reply from an async operation result returning an effect.
- asyncProduce(CompletionStage<S>) - Method in interface akka.javasdk.consumer.Consumer.Effect.Builder
-
Produce a message from an async operation result.
- asyncProduce(CompletionStage<S>, Metadata) - Method in interface akka.javasdk.consumer.Consumer.Effect.Builder
-
Produce a message from an async operation result with custom Metadata.
- audience() - Method in interface akka.javasdk.JwtClaims
-
Get the audience, that is, the aud claim, as described in RFC 7519 section 4.1.3.
- AUTHENTICATION_REQUIRED - Enum constant in enum class akka.javasdk.annotations.Acl.DenyStatusCode
B
- BACKOFFICE - Enum constant in enum class akka.javasdk.Principal.Basic
- BACKOFFICE - Static variable in interface akka.javasdk.Principal
-
Abstract principal representing all requests from the backoffice
- BAD_REQUEST - Enum constant in enum class akka.javasdk.annotations.Acl.DenyStatusCode
- 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.
- BEARER_TOKEN - Enum constant in enum class akka.javasdk.annotations.JWT.JwtMethodMode
-
Validates that the bearer token is present on the request, in the 'Authorization' header.
- bearerTokenIssuers() - Element in annotation interface akka.javasdk.annotations.JWT
-
If set, then the token extracted from the bearer token must have one of these issuers.
- body() - Method in record class akka.javasdk.http.StrictResponse
-
Returns the value of the
body
record component.
C
- callFunc - Variable in class akka.javasdk.workflow.Workflow.AsyncCallStep
- callFunc - Variable in class akka.javasdk.workflow.Workflow.CallStep
- callInputClass - Variable in class akka.javasdk.workflow.Workflow.AsyncCallStep
- callInputClass - Variable in class akka.javasdk.workflow.Workflow.CallStep
- CallStep(String, Class<CallInput>, Function<CallInput, DeferredCall<DefCallInput, DefCallOutput>>, Class<DefCallOutput>, Function<DefCallOutput, Workflow.Effect.TransitionalEffect<Void>>) - Constructor for class akka.javasdk.workflow.Workflow.CallStep
- CallStepBuilder(String, Class<Input>, Function<Input, DeferredCall<DefCallInput, DefCallOutput>>) - Constructor for class akka.javasdk.workflow.StepBuilder.CallStepBuilder
- cancel(String) - Method in interface akka.javasdk.timer.TimerScheduler
-
Cancel an existing timer.
- claim() - Element in annotation interface akka.javasdk.annotations.JWT.StaticClaim
-
The claim name needs to be a hardcoded literal (e.g.
- 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.
- 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.
- CloudEvent - Interface in akka.javasdk
-
CloudEvent representation of Metadata.
- commandContext() - Method in class akka.javasdk.eventsourcedentity.EventSourcedEntity
-
Additional context and metadata for a command handler.
- commandContext() - Method in class akka.javasdk.keyvalueentity.KeyValueEntity
-
Additional context and metadata for a command handler.
- 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
-
An event sourced command context.
- CommandContext - Interface in akka.javasdk.keyvalueentity
-
A value based entity command context.
- 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.
- commandId() - Method in interface akka.javasdk.eventsourcedentity.CommandContext
-
The id of the command being executed.
- commandId() - Method in interface akka.javasdk.keyvalueentity.CommandContext
-
The id of the command being executed.
- commandId() - Method in interface akka.javasdk.workflow.CommandContext
-
The id of the command being executed.
- commandName() - Method in interface akka.javasdk.eventsourcedentity.CommandContext
-
The name of the command being executed.
- commandName() - Method in interface akka.javasdk.keyvalueentity.CommandContext
-
The name of the command being executed.
- commandName() - Method in interface akka.javasdk.workflow.CommandContext
-
The name of the command being executed.
- 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 - Annotation Interface in akka.javasdk.annotations
-
Assign a type identifier to a component (required for all component types aside from Endpoints).
- ComponentInvokeOnlyMethodRef<R> - Interface in akka.javasdk.client
-
Zero argument component call representation, not executed until invoked.
- ComponentInvokeOnlyMethodRef1<A1,
R> - Interface in akka.javasdk.client -
One argument component call representation, not executed until invoked.
- ComponentMethodRef<R> - Interface in akka.javasdk.client
-
Zero argument component call representation, not executed until invoked or by some mechanism using the deferred call (like a timer executing it later for example)
- ComponentMethodRef1<A1,
R> - Interface in akka.javasdk.client -
One argument component call representation, not executed until invoked or by some mechanism using the deferred call (like a timer executing it later for example)
- ComponentStreamMethodRef<R> - Interface in akka.javasdk.client
-
Zero argument component call representation, not executed until stream is materialized.
- ComponentStreamMethodRef1<A1,
R> - Interface in akka.javasdk.client -
One argument component call representation, not executed until stream is materialized.
- CONFLICT - Enum constant in enum class akka.javasdk.annotations.Acl.DenyStatusCode
- 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).
- Consumer - Class in akka.javasdk.consumer
-
Consumers are stateless components that can be used to implement different uses cases, such as:
- Consumer() - Constructor for class akka.javasdk.consumer.Consumer
- Consumer.Effect - Interface in akka.javasdk.consumer
-
An Effect is a description of what the runtime needs to do after the command is handled.
- Consumer.Effect.Builder - Interface in akka.javasdk.consumer
-
Construct the effect that is returned by the message handler.
- consumerGroup() - Element in annotation interface akka.javasdk.annotations.Consume.FromServiceStream
-
In case you need to consume the same stream multiple times, each subscription should have a unique consumer group.
- consumerGroup() - Element in annotation interface akka.javasdk.annotations.Consume.FromTopic
-
Assign the consumer group name to be used on the broker.
- Context - Interface in akka.javasdk
-
Root class of all contexts.
- 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 service is started, to create a dependency provider.
- currentState() - Method in class akka.javasdk.eventsourcedentity.EventSourcedEntity
-
Returns the state as currently stored.
- currentState() - Method in class akka.javasdk.keyvalueentity.KeyValueEntity
-
Returns the state as currently stored.
- currentState() - Method in class akka.javasdk.workflow.Workflow
-
Returns the state as currently stored.
- currentVersion() - Method in class akka.javasdk.JsonMigration
-
Define current version, that is, the value used when serializing new data.
D
- datacontenttype() - Method in interface akka.javasdk.CloudEvent
-
The data content type of this CloudEvent.
- dataschema() - Method in interface akka.javasdk.CloudEvent
-
The data schema of this CloudEvent.
- decodeJson(Class<T>, Any) - Static method in class akka.javasdk.JsonSupport
-
Decode the given protobuf Any object to an instance of T using Jackson.
- decodeJson(Class<T>, String, Any) - Static method in class akka.javasdk.JsonSupport
-
Decode the given protobuf Any to an instance of T using Jackson but only if the suffix of the type URL matches the given jsonType.
- decodeJsonCollection(Class<T>, Class<C>, Any) - Static method in class akka.javasdk.JsonSupport
- defaultStepRecoverStrategy(Workflow.RecoverStrategy) - Method in class akka.javasdk.workflow.Workflow.WorkflowDef
-
Define a default step recovery strategy.
- defaultStepTimeout(Duration) - Method in class akka.javasdk.workflow.Workflow.WorkflowDef
-
Define a default step timeout.
- deferred() - Method in interface akka.javasdk.client.ComponentDeferredMethodRef
- deferred(A1) - Method in interface akka.javasdk.client.ComponentDeferredMethodRef1
- DeferredCall<I,
O> - Interface in akka.javasdk -
Represents a call to another component that can be persisted and invoked later.
- definition() - Method in class akka.javasdk.workflow.Workflow
- Delete - Annotation Interface in akka.javasdk.annotations.http
- DELETE(String) - Method in interface akka.javasdk.http.HttpClient
- deleteEntity() - Method in interface akka.javasdk.eventsourcedentity.EventSourcedEntity.Effect.OnSuccessBuilder
-
Delete the entity.
- deleteEntity() - Method in interface akka.javasdk.keyvalueentity.KeyValueEntity.Effect.Builder
-
Delete the entity.
- DeleteHandler - Annotation Interface in akka.javasdk.annotations
- deleteRow() - Method in interface akka.javasdk.view.TableUpdater.Effect.Builder
- deny() - Element in annotation interface akka.javasdk.annotations.Acl
-
After matching an allow rule, an incoming request that has at least one principal that matches a deny rule will be denied.
- denyCode() - Element in annotation interface akka.javasdk.annotations.Acl
-
The status code to respond with when access is denied.
- DependencyProvider - Interface in akka.javasdk
-
A factory method to provide additional dependencies to the component implementations.
- done() - Method in interface akka.javasdk.consumer.Consumer.Effect.Builder
-
Mark message as processed.
- done() - Method in interface akka.javasdk.timedaction.TimedAction.Effect.Builder
-
Command was processed successfully.
E
- effects() - Method in class akka.javasdk.consumer.Consumer
- effects() - Method in class akka.javasdk.eventsourcedentity.EventSourcedEntity
- effects() - Method in class akka.javasdk.keyvalueentity.KeyValueEntity
- effects() - Method in class akka.javasdk.timedaction.TimedAction
- effects() - Method in class akka.javasdk.view.TableUpdater
- effects() - Method in class akka.javasdk.workflow.Workflow
- EMPTY - Static variable in 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.eventsourcedentity.EventSourcedEntity
-
Implement by returning the initial empty state object.
- emptyState() - Method in class akka.javasdk.keyvalueentity.KeyValueEntity
-
Implement by returning the initial empty state object.
- emptyState() - Method in class akka.javasdk.workflow.Workflow
-
Returns the initial empty state object.
- encodeDynamicCollectionToAkkaByteString(String, Collection<?>) - Static method in class akka.javasdk.JsonSupport
- encodeDynamicToAkkaByteString(String, String) - Static method in class akka.javasdk.JsonSupport
- encodeJson(T) - Static method in class akka.javasdk.JsonSupport
-
Encode the given value as JSON using Jackson and put the encoded string as bytes in a protobuf Any with the type URL
"json.kalix.io/[valueClassName]"
. - encodeJson(T, String) - Static method in class akka.javasdk.JsonSupport
-
Encode the given value as JSON using Jackson and put the encoded string as bytes in a protobuf Any with the type URL
"json.kalix.io/[jsonType]"
. - encodeToAkkaByteString(T) - Static method in class akka.javasdk.JsonSupport
- encodeToBytes(T) - Static method in class akka.javasdk.JsonSupport
- end() - Method in interface akka.javasdk.workflow.Workflow.Effect.Builder
-
Finish the workflow execution.
- end() - Method in interface akka.javasdk.workflow.Workflow.Effect.PersistenceEffectBuilder
-
Finish the workflow execution.
- EntityContext - Interface in akka.javasdk
-
Root context for all contexts that pertain to entities, that is, things that are addressable via an entity id.
- entityId() - Method in interface akka.javasdk.EntityContext
-
The id of the entity that this context is for.
- entityId() - Method in interface akka.javasdk.eventsourcedentity.CommandContext
-
The id of the entity that this context is for.
- entityId() - Method in interface akka.javasdk.keyvalueentity.CommandContext
-
The id of the entity that this context is for.
- equals(Object) - Method in record class akka.javasdk.http.StrictResponse
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in class akka.javasdk.Principal.LocalService
- error(StatusCode) - Static method in class akka.javasdk.http.HttpException
- error(StatusCode, String) - Static method in class akka.javasdk.http.HttpException
- error(String) - Method in interface akka.javasdk.eventsourcedentity.EventSourcedEntity.Effect.Builder
-
Create an error reply.
- error(String) - Method in interface akka.javasdk.keyvalueentity.KeyValueEntity.Effect.Builder
-
Create an error reply.
- error(String) - Method in interface akka.javasdk.timedaction.TimedAction.Effect.Builder
-
Create an error reply.
- error(String) - Method in interface akka.javasdk.workflow.Workflow.Effect.Builder
-
Create an error reply.
- eventContext() - Method in class akka.javasdk.eventsourcedentity.EventSourcedEntity
-
Additional context and metadata when handling an event in the
EventSourcedEntity.applyEvent(E)
method. - EventContext - Interface in akka.javasdk.eventsourcedentity
-
Context for an event.
- eventName() - Method in interface akka.javasdk.view.UpdateContext
-
The name of the event being handled.
- EventSourcedEntity<S,
E> - Class in akka.javasdk.eventsourcedentity -
The Event Sourced state model captures changes to data by storing events in a journal.
- EventSourcedEntity() - Constructor for class akka.javasdk.eventsourcedentity.EventSourcedEntity
- EventSourcedEntity.Effect<T> - Interface in akka.javasdk.eventsourcedentity
-
An Effect is a description of what the runtime needs to do after the command is handled.
- 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
-
Root context for all event sourcing contexts.
- 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
. - expirationTime() - Method in interface akka.javasdk.JwtClaims
-
Get the expiration time, that is, the exp claim, as described in RFC 7519 section 4.1.4.
F
- failoverStepInput - Variable in class akka.javasdk.workflow.Workflow.RecoverStrategy
- failoverStepName - Variable in class akka.javasdk.workflow.Workflow.RecoverStrategy
- failoverTo(String) - Static method in class akka.javasdk.workflow.Workflow.RecoverStrategy
-
In case of a step failure don't retry but transition to a given step name.
- failoverTo(String) - Method in class akka.javasdk.workflow.Workflow.RecoverStrategy.MaxRetries
-
Once max retries is exceeded, transition to a given step name.
- failoverTo(String, Workflow.RecoverStrategy.MaxRetries) - Method in class akka.javasdk.workflow.Workflow.WorkflowDef
-
Define a failover step name after workflow timeout.
- failoverTo(String, I, Workflow.RecoverStrategy.MaxRetries) - Method in class akka.javasdk.workflow.Workflow.WorkflowDef
-
Define a failover step name after workflow timeout.
- failoverTo(String, T) - Static method in class akka.javasdk.workflow.Workflow.RecoverStrategy
-
In case of a step failure don't retry but transition to a given step name with the input parameter.
- failoverTo(String, T) - Method in class akka.javasdk.workflow.Workflow.RecoverStrategy.MaxRetries
-
Once max retries is exceeded, transition to a given step name with the input parameter.
- findByName(String) - Method in class akka.javasdk.workflow.Workflow.WorkflowDef
- forbidden() - Static method in class akka.javasdk.http.HttpException
- forbidden(String) - Static method in class akka.javasdk.http.HttpException
- FORBIDDEN - Enum constant in enum class akka.javasdk.annotations.Acl.DenyStatusCode
- forEventSourcedEntity(String) - Method in interface akka.javasdk.client.ComponentClient
-
Select
EventSourcedEntity
as a call target component. - forKeyValueEntity(String) - Method in interface akka.javasdk.client.ComponentClient
-
Select
KeyValueEntity
as a call target component. - forTimedAction() - Method in interface akka.javasdk.client.ComponentClient
-
Select
TimedAction
as a call target component. - forView() - Method in interface akka.javasdk.client.ComponentClient
-
Select
View
as a call target component. - forWorkflow(String) - Method in interface akka.javasdk.client.ComponentClient
-
Select
Workflow
as a call target component.
G
- GATEWAY_TIMEOUT - Enum constant in enum class akka.javasdk.annotations.Acl.DenyStatusCode
- get() - Method in interface akka.javasdk.Principals
-
Get the principals associated with this request.
- get(String) - Method in interface akka.javasdk.Metadata
-
Get the string value for the given key, if found.
- Get - Annotation Interface in akka.javasdk.annotations.http
- GET(String) - Method in interface akka.javasdk.http.HttpClient
- getAll(String) - Method in interface akka.javasdk.Metadata
-
Get all the string values for a given key.
- getAllKeys() - Method in interface akka.javasdk.Metadata
-
Get all the keys for all the entries.
- getBinary(String) - Method in interface akka.javasdk.Metadata
-
Get the binary value for the given key, if found.
- getBinaryAll(String) - Method in interface akka.javasdk.Metadata
-
Get all the binary values for a given key.
- getBinaryValue() - Method in interface akka.javasdk.Metadata.MetadataEntry
-
The binary value for the metadata entry.
- 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.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.
- getFailoverMaxRetries() - Method in class akka.javasdk.workflow.Workflow.WorkflowDef
- getFailoverStepInput() - Method in class akka.javasdk.workflow.Workflow.WorkflowDef
- getFailoverStepName() - Method in class akka.javasdk.workflow.Workflow.WorkflowDef
- 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.http.RequestContext
- getKey() - Method in interface akka.javasdk.Metadata.MetadataEntry
-
The key for the metadata entry.
- getLocalService() - Method in interface akka.javasdk.Principals
-
Get the service that invoked this call, if any.
- getLong(String) - Method in interface akka.javasdk.JwtClaims
-
Get the long claim with the given name.
- getLongList(String) - Method in interface akka.javasdk.JwtClaims
-
Get the long list claim with the given name.
- getMaxRetries() - Method in class akka.javasdk.workflow.Workflow.RecoverStrategy.MaxRetries
- getName() - Method in class akka.javasdk.Principal.LocalService
- getNumericDate(String) - Method in interface akka.javasdk.JwtClaims
-
Get the numeric data claim with the given name.
- getNumericDateList(String) - Method in interface akka.javasdk.JwtClaims
-
Get the numeric date list claim with the given name.
- getObject(String) - Method in interface akka.javasdk.JwtClaims
-
Get the object claim with the given name.
- getObjectList(String) - Method in interface akka.javasdk.JwtClaims
-
Get the object list claim with the given name.
- getObjectMapper() - Static method in class akka.javasdk.JsonSupport
-
The Jackson ObjectMapper that is used for encoding and decoding JSON.
- getPrincipals() - Method in interface akka.javasdk.http.RequestContext
-
Get the principals associated with this request.
- getStepConfigs() - Method in class akka.javasdk.workflow.Workflow.WorkflowDef
- getStepRecoverStrategy() - Method in class akka.javasdk.workflow.Workflow.WorkflowDef
- getSteps() - Method in class akka.javasdk.workflow.Workflow.WorkflowDef
- getStepTimeout() - Method in class akka.javasdk.workflow.Workflow.WorkflowDef
- getString(String) - Method in interface akka.javasdk.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.
- getTracer() - Method in interface akka.javasdk.consumer.MessageContext
-
Get an OpenTelemetry tracer for the current message.
- getTracer() - Method in interface akka.javasdk.timedaction.CommandContext
-
Get an OpenTelemetry tracer for the current action.
- getValue() - Method in interface akka.javasdk.Metadata.MetadataEntry
-
The string value for the metadata entry.
- getWorkflowTimeout() - Method in class akka.javasdk.workflow.Workflow.WorkflowDef
H
- has(String) - Method in interface akka.javasdk.Metadata
-
Check whether this metadata has a entry for the given key.
- hasClaims() - Method in interface akka.javasdk.JwtClaims
-
Does this request have any claims that have been validated?
- hashCode() - Method in record class akka.javasdk.http.StrictResponse
-
Returns a hash code value for this object.
- hashCode() - Method in class akka.javasdk.Principal.LocalService
- HttpClient - Interface in akka.javasdk.http
-
Not for user extension, instances provided by
HttpClientProvider
and the testkit. - httpClientFor(String) - Method in interface akka.javasdk.http.HttpClientProvider
-
Returns a
HttpClient
configured to connect to another service deployed on the same project. - HttpClientProvider - Interface in akka.javasdk.http
-
Not for user extension, instances are available through injection in selected component types.
- HttpEndpoint - Annotation Interface in akka.javasdk.annotations.http
-
Mark a class to be made available as an HTTP endpoint.
- HttpException - Class in akka.javasdk.http
- httpResponse() - Method in record class akka.javasdk.http.StrictResponse
-
Returns the value of the
httpResponse
record component. - HttpResponses - Class in akka.javasdk.http
-
Helper class for creating common HTTP responses.
I
- 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.
- 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.
- inheritDenyCode() - Element in annotation interface akka.javasdk.annotations.Acl
-
If
true
, indicates that thedenyCode
should be inherited from the parent. - INTERNAL_SERVER_ERROR - Enum constant in enum class akka.javasdk.annotations.Acl.DenyStatusCode
- 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.
- 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
- invokeAsync() - Method in interface akka.javasdk.client.ComponentInvokeOnlyMethodRef
- invokeAsync() - Method in interface akka.javasdk.client.ComponentMethodRef
- invokeAsync() - Method in interface akka.javasdk.http.RequestBuilder
- invokeAsync(A1) - Method in interface akka.javasdk.client.ComponentInvokeOnlyMethodRef1
- invokeAsync(A1) - Method in interface akka.javasdk.client.ComponentMethodRef1
- isAnyLocalService() - Method in interface akka.javasdk.Principals
-
Whether this request was from any service in the local project.
- isBackoffice() - Method in interface akka.javasdk.Principals
-
Whether this request is a backoffice request.
- isBinary() - Method in interface akka.javasdk.Metadata.MetadataEntry
-
Whether this entry is a binary entry.
- isCloudEvent() - Method in interface akka.javasdk.Metadata
-
Whether this metadata is also a CloudEvent.
- isInternet() - Method in interface akka.javasdk.Principals
-
Whether this request was from the internet.
- isLocalService(String) - Method in interface akka.javasdk.Principals
-
Whether this request was from a service in the local project.
- isSelf() - Method in interface akka.javasdk.Principals
-
Whether this is a self request.
- issuedAt() - Method in interface akka.javasdk.JwtClaims
-
Get the issued at, that is, the iat claim, as described in RFC 7519 section 4.1.6.
- issuer() - Method in interface akka.javasdk.JwtClaims
-
Get the issuer, that is, the iss claim, as described in RFC 7519 section 4.1.1.
- isText() - Method in interface akka.javasdk.Metadata.MetadataEntry
-
Whether this entry is a text entry.
J
- JSON_TYPE_URL_PREFIX - Static variable in class akka.javasdk.JsonSupport
- JsonMigration - Class in akka.javasdk
-
Allows to specify dedicated strategy for JSON schema evolution.
- JsonMigration() - Constructor for class akka.javasdk.JsonMigration
- JsonSupport - Class in akka.javasdk
- JWT - Annotation Interface in akka.javasdk.annotations
- JWT.JwtMethodMode - Enum Class in akka.javasdk.annotations
- JWT.StaticClaim - Annotation Interface in akka.javasdk.annotations
-
A static claim is a claim that is required to be present on the token, and have a particular value.
- JwtClaims - Interface in akka.javasdk
-
Representation of JWT claims that have been validated and extracted from the bearer token of a request.
- jwtId() - Method in interface akka.javasdk.JwtClaims
-
Get the JWT ID, that is, the jti claim, as described in RFC 7519 section 4.1.7.
K
- KeyValueEntity<S> - Class in akka.javasdk.keyvalueentity
-
Key Value Entities persist their state on every change.
- KeyValueEntity() - Constructor for class akka.javasdk.keyvalueentity.KeyValueEntity
- KeyValueEntity.Effect<T> - Interface in akka.javasdk.keyvalueentity
-
An Effect is a description of what the runtime needs to do after the command is handled.
- KeyValueEntity.Effect.Builder<S> - Interface in akka.javasdk.keyvalueentity
-
Construct the effect that is returned by the command handler.
- KeyValueEntity.Effect.OnSuccessBuilder<S> - Interface in akka.javasdk.keyvalueentity
- KeyValueEntityClient - Interface in akka.javasdk.client
-
Not for user extension
- KeyValueEntityContext - Interface in akka.javasdk.keyvalueentity
-
Root context for all value based entity contexts.
L
- localService(String) - Static method in interface akka.javasdk.Principal
-
Create a local service principal with the given name
- LogbackJsonLayout - Class in akka.javasdk.logging
-
This Logback JSON layout uses the name
severity
(instead oflevel
). - LogbackJsonLayout() - Constructor for class akka.javasdk.logging.LogbackJsonLayout
M
- maxRetries - Variable in class akka.javasdk.workflow.Workflow.RecoverStrategy
- maxRetries - Variable in class akka.javasdk.workflow.Workflow.RecoverStrategy.MaxRetries
- maxRetries(int) - Method in class akka.javasdk.workflow.Workflow
-
Starts defining a recover strategy for the workflow or a specific step.
- maxRetries(int) - Static method in class akka.javasdk.workflow.Workflow.RecoverStrategy
-
Set the number of retires for a failed step,
maxRetries
equals 0 means that the step won't retry in case of failure. - MaxRetries(int) - Constructor for class akka.javasdk.workflow.Workflow.RecoverStrategy.MaxRetries
- merge(Metadata) - Method in interface akka.javasdk.Metadata
-
Merge the given Metadata entries with this Metadata.
- message() - Method in interface akka.javasdk.DeferredCall
-
The message to pass to the call when the call is invoked.
- messageContext() - Method in class akka.javasdk.consumer.Consumer
-
Additional context and metadata for a message handler.
- MessageContext - Interface in akka.javasdk.consumer
-
Context for an incoming message.
- MessageEnvelope<T> - Interface in akka.javasdk.consumer
-
A message envelope.
- 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.MetadataContext
-
Get the metadata associated with this context.
- metadata() - Method in interface akka.javasdk.timedaction.CommandEnvelope
-
The metadata associated with the command.
- Metadata - Interface in akka.javasdk
-
Transport specific metadata.
- Metadata.MetadataEntry - Interface in akka.javasdk
-
A metadata entry.
- MetadataContext - Interface in akka.javasdk
-
Context that provides access to metadata.
- method(Function<T, EventSourcedEntity.Effect<R>>) - Method in interface akka.javasdk.client.EventSourcedEntityClient
-
Pass in an Event Sourced Entity command handler method reference, e.g.
- method(Function<T, KeyValueEntity.Effect<R>>) - Method in interface akka.javasdk.client.KeyValueEntityClient
-
Pass in a Key Value Entity command handler method reference, e.g.
- method(Function<T, TimedAction.Effect>) - Method in interface akka.javasdk.client.TimedActionClient
-
Pass in an Action method reference, e.g.
- method(Function<T, View.QueryEffect<R>>) - Method in interface akka.javasdk.client.ViewClient
-
Pass in a View query method reference, e.g.
- method(Function<T, Workflow.Effect<R>>) - Method in interface akka.javasdk.client.WorkflowClient
-
Pass in a Workflow method reference annotated as a REST endpoint, e.g.
- method(Function2<T, A1, EventSourcedEntity.Effect<R>>) - Method in interface akka.javasdk.client.EventSourcedEntityClient
-
Pass in an Event Sourced Entity command handler method reference, e.g.
- method(Function2<T, A1, KeyValueEntity.Effect<R>>) - Method in interface akka.javasdk.client.KeyValueEntityClient
-
Pass in a Key Value Entity command handler method reference, e.g.
- method(Function2<T, A1, TimedAction.Effect>) - Method in interface akka.javasdk.client.TimedActionClient
-
Pass in an Action method reference, e.g.
- method(Function2<T, A1, View.QueryEffect<R>>) - Method in interface akka.javasdk.client.ViewClient
-
Pass in a View query method reference, e.g.
- method(Function2<T, A1, Workflow.Effect<R>>) - Method in interface akka.javasdk.client.WorkflowClient
-
Pass in a Workflow method reference annotated as a REST endpoint, e.g.
- Migration - Annotation Interface in akka.javasdk.annotations
-
Annotation to assign a @
JsonMigration
implementation for a given class. - modifyRequest(Function<HttpRequest, HttpRequest>) - Method in interface akka.javasdk.http.RequestBuilder
-
Transform the request before sending it.
N
- name() - Method in class akka.javasdk.workflow.Workflow.AsyncCallStep
- name() - Method in class akka.javasdk.workflow.Workflow.CallStep
- name() - Method in interface akka.javasdk.workflow.Workflow.Step
- noContent() - Static method in class akka.javasdk.http.HttpResponses
-
Creates a 204 NO CONTENT response.
- NoEntryFoundException - Exception Class in akka.javasdk.client
-
Thrown for a query where the query result would be a single entry but none was found.
- NoEntryFoundException(String) - Constructor for exception class akka.javasdk.client.NoEntryFoundException
- NOT_FOUND - Enum constant in enum class akka.javasdk.annotations.Acl.DenyStatusCode
- notBefore() - Method in interface akka.javasdk.JwtClaims
-
Get the not before, that is, the nbf claim, as described in RFC 7519 section 4.1.5.
- notFound() - Static method in class akka.javasdk.http.HttpException
- notFound() - Static method in class akka.javasdk.http.HttpResponses
-
Creates a 404 NOT FOUND response.
- notFound(String) - Static method in class akka.javasdk.http.HttpResponses
-
Creates a 404 NOT FOUND response with a text/plain body.
- notImplemented() - Static method in class akka.javasdk.http.HttpException
- notImplemented() - Static method in class akka.javasdk.http.HttpResponses
-
Creates a 501 NOT IMPLEMENTED response.
- notImplemented(String) - Static method in class akka.javasdk.http.HttpResponses
-
Creates a 501 NOT IMPLEMENTED response with a text/plain body.
O
- of(StatusCode, ContentType, byte[]) - Static method in class akka.javasdk.http.HttpResponses
-
Creates an HTTP response with specified status code, content type and body.
- of(String, URI, String) - Static method in interface akka.javasdk.CloudEvent
-
Create a CloudEvent.
- of(T) - Static method in interface akka.javasdk.consumer.MessageEnvelope
-
Create a message.
- of(T) - Static method in interface akka.javasdk.timedaction.CommandEnvelope
-
Create a command envelope.
- of(T, Metadata) - Static method in interface akka.javasdk.consumer.MessageEnvelope
-
Create a message.
- of(T, Metadata) - Static method in interface akka.javasdk.timedaction.CommandEnvelope
-
Create a command envelope.
- ok() - Static method in class akka.javasdk.http.HttpResponses
-
Creates a 200 OK response.
- ok(Object) - Static method in class akka.javasdk.http.HttpResponses
-
Creates a 200 OK response with an application/json body.
- ok(String) - Static method in class akka.javasdk.http.HttpResponses
-
Creates a 200 OK response with a text/plain body.
- onStartup() - Method in interface akka.javasdk.ServiceSetup
-
The on startup hook is called every time a service instance boots up.
P
- parseBytes(byte[], Class<T>) - Static method in class akka.javasdk.JsonSupport
- parseResponseBody(Function<byte[], T>) - Method in interface akka.javasdk.http.RequestBuilder
-
Converts the response body to the specified type using the provided parser function.
- Patch - Annotation Interface in akka.javasdk.annotations.http
- PATCH(String) - Method in interface akka.javasdk.http.HttpClient
- pattern() - Element in annotation interface akka.javasdk.annotations.JWT.StaticClaim
-
This receives a regex expression (Java flavor) used to match on the incoming claim value.
- pause() - Method in interface akka.javasdk.workflow.Workflow.Effect.Builder
-
Pause the workflow execution and wait for an external input, e.g.
- pause() - Method in interface akka.javasdk.workflow.Workflow.Effect.PersistenceEffectBuilder
-
Pause the workflow execution and wait for an external input, e.g.
- payload() - Method in interface akka.javasdk.consumer.MessageEnvelope
-
The payload of the message.
- payload() - Method in interface akka.javasdk.timedaction.CommandEnvelope
-
The payload of the command.
- persist(E) - Method in interface akka.javasdk.eventsourcedentity.EventSourcedEntity.Effect.Builder
-
Persist a single event.
- persist(E, E, E...) - Method in interface akka.javasdk.eventsourcedentity.EventSourcedEntity.Effect.Builder
-
Persist the passed events.
- persistAll(List<? extends E>) - Method in interface akka.javasdk.eventsourcedentity.EventSourcedEntity.Effect.Builder
-
Persist the passed List of events.
- Post - Annotation Interface in akka.javasdk.annotations.http
- POST(String) - Method in interface akka.javasdk.http.HttpClient
- principal() - Element in annotation interface akka.javasdk.annotations.Acl.Matcher
-
A principal matcher that can be specified with no additional configuration.
- Principal - Interface in akka.javasdk
-
A principal associated with a request.
- Principal.Basic - Enum Class in akka.javasdk
-
Basic principals that have no additional configuration.
- Principal.LocalService - Class in akka.javasdk
-
A local service principal.
- Principals - Interface in akka.javasdk
-
The principals associated with a request.
- produce(S) - Method in interface akka.javasdk.consumer.Consumer.Effect.Builder
-
Produce a message.
- produce(S, Metadata) - Method in interface akka.javasdk.consumer.Consumer.Effect.Builder
-
Produce a message with custom Metadata.
- Produce - Annotation Interface in akka.javasdk.annotations
-
Annotation for ways of producing outgoing information.
- Produce.ServiceStream - Annotation Interface in akka.javasdk.annotations
-
Annotation to configure the component to produce an event stream that can be consumed by other services.
- Produce.ToTopic - Annotation Interface in akka.javasdk.annotations
-
Annotation for marking a method as producing information to be published on a PubSub or Kafka topic.
- Put - Annotation Interface in akka.javasdk.annotations.http
- PUT(String) - Method in interface akka.javasdk.http.HttpClient
Q
- Query - Annotation Interface in akka.javasdk.annotations
-
Annotation used in the scope of a view for providing the query that will be used to explore data from that view.
- queryResult() - Method in class akka.javasdk.view.View
- queryStreamResult() - Method in class akka.javasdk.view.View
R
- recoverStrategy - Variable in class akka.javasdk.workflow.Workflow.StepConfig
- RecoverStrategy(int, String, Optional<T>) - Constructor for class akka.javasdk.workflow.Workflow.RecoverStrategy
- remove(String) - Method in interface akka.javasdk.Metadata
-
Remove all metadata entries with the given key.
- 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.eventsourcedentity.EventSourcedEntity.Effect.Builder
-
Create a message reply.
- reply(T) - Method in interface akka.javasdk.keyvalueentity.KeyValueEntity.Effect.Builder
-
Create a message reply.
- 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
-
Create a message reply.
- RequestBuilder<R> - Interface in akka.javasdk.http
-
A builder for HTTP requests and handling of their responses
- RequestContext - Interface in akka.javasdk.http
-
Not for user extension, can be injected as constructor parameter into HTTP endpoint components
- responseBodyAs(Class<T>) - Method in interface akka.javasdk.http.RequestBuilder
-
Converts the response body to the specified type.
- rowState() - Method in class akka.javasdk.view.TableUpdater
-
Returns the current state of the row for the subject that is being updated.
S
- SELF - Enum constant in enum class akka.javasdk.Principal.Basic
- SELF - Static variable in interface akka.javasdk.Principal
-
Abstract principal representing all requests from self
- sequenceNumber() - Method in interface akka.javasdk.eventsourcedentity.CommandContext
-
The current sequence number of events in this entity.
- sequenceNumber() - Method in interface akka.javasdk.eventsourcedentity.EventContext
-
The sequence number of the current event being processed.
- 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.
- SERVICE_UNAVAILABLE - Enum constant in enum class akka.javasdk.annotations.Acl.DenyStatusCode
- 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. - set(String, String) - Method in interface akka.javasdk.Metadata
-
Set the string value for the given key.
- setBinary(String, ByteBuffer) - Method in interface akka.javasdk.Metadata
-
Set the binary value for the given key.
- Setup - Annotation Interface in akka.javasdk.annotations
-
Mark a class as a central configuration point for an entire service.
- single(Object) - Static method in interface akka.javasdk.DependencyProvider
-
Create a dependency provider that always returns the same instance for a given class.
- source() - Method in interface akka.javasdk.client.ComponentStreamMethodRef
- source() - Method in interface akka.javasdk.CloudEvent
-
The source of this CloudEvent.
- source(A1) - Method in interface akka.javasdk.client.ComponentStreamMethodRef1
- specversion() - Method in interface akka.javasdk.CloudEvent
-
The CloudEvent spec version.
- startSingleTimer(String, Duration, int, DeferredCall<I, O>) - Method in interface akka.javasdk.timer.TimerScheduler
-
Schedule a single timer.
- startSingleTimer(String, Duration, DeferredCall<I, O>) - Method in interface akka.javasdk.timer.TimerScheduler
-
Schedule a single timer.
- 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.
- status() - Method in record class akka.javasdk.http.StrictResponse
- step(String) - Method in class akka.javasdk.workflow.StepBuilder
- step(String) - Method in class akka.javasdk.workflow.Workflow
-
Start a step definition with a given step name.
- StepBuilder - Class in akka.javasdk.workflow
- StepBuilder(String) - Constructor for class akka.javasdk.workflow.StepBuilder
- StepBuilder.AsyncCallStepBuilder<CallInput,
CallOutput> - Class in akka.javasdk.workflow - StepBuilder.CallStepBuilder<Input,
DefCallInput, - Class in akka.javasdk.workflowDefCallOutput> - StepConfig(String, Optional<Duration>, Optional<Workflow.RecoverStrategy<?>>) - Constructor for class akka.javasdk.workflow.Workflow.StepConfig
- stepName - Variable in class akka.javasdk.workflow.Workflow.StepConfig
- stream(Function<T, View.QueryStreamEffect<R>>) - Method in interface akka.javasdk.client.ViewClient
-
Pass in a View query method reference, e.g.
- stream(Function2<T, A1, View.QueryStreamEffect<R>>) - Method in interface akka.javasdk.client.ViewClient
-
Pass in a View query method reference, e.g.
- streamUpdates() - Element in annotation interface akka.javasdk.annotations.Query
-
For a query that returns a
View.QueryStreamEffect
, instead of completing the stream once the end of the result is reached, keep tailing the query and emit updates to the stream as the view is updated. - StrictResponse<T> - Record Class in akka.javasdk.http
-
A strict response that contains both the HTTP response and the body.
- StrictResponse(HttpResponse, T) - Constructor for record class akka.javasdk.http.StrictResponse
-
Creates an instance of a
StrictResponse
record class. - subject() - Method in interface akka.javasdk.CloudEvent
-
The subject of this CloudEvent.
- subject() - Method in interface akka.javasdk.JwtClaims
-
Get the subject, that is, the sub claim, as described in RFC 7519 section 4.1.2.
- supportedClassNames() - Method in class akka.javasdk.JsonMigration
-
Override this method if you have changed the class name.
- supportedForwardVersion() - Method in class akka.javasdk.JsonMigration
-
Define the supported forward version this migration can read (must be greater or equal than
currentVersion
).
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
- thenReply(Function<S, T>) - Method in interface akka.javasdk.eventsourcedentity.EventSourcedEntity.Effect.OnSuccessBuilder
-
Reply after for example
persist
event. - thenReply(Function<S, T>, Metadata) - Method in interface akka.javasdk.eventsourcedentity.EventSourcedEntity.Effect.OnSuccessBuilder
-
Reply after for example
persist
event. - thenReply(R) - Method in interface akka.javasdk.workflow.Workflow.Effect.TransitionalEffect
-
Reply after for example
updateState
. - thenReply(R, Metadata) - Method in interface akka.javasdk.workflow.Workflow.Effect.TransitionalEffect
-
Reply after for example
updateState
. - thenReply(T) - Method in interface akka.javasdk.keyvalueentity.KeyValueEntity.Effect.OnSuccessBuilder
-
Reply after for example
updateState
. - thenReply(T, Metadata) - Method in interface akka.javasdk.keyvalueentity.KeyValueEntity.Effect.OnSuccessBuilder
-
Reply after for example
updateState
. - time() - Method in interface akka.javasdk.CloudEvent
-
The time of this CloudEvent.
- TimedAction - Class in akka.javasdk.timedaction
-
TimedAction is stateless component that can be used together with a
TimerScheduler
to schedule an action. - TimedAction() - Constructor for class akka.javasdk.timedaction.TimedAction
- TimedAction.Effect - Interface in akka.javasdk.timedaction
-
An Effect is a description of what the runtime needs to do after the command is handled.
- TimedAction.Effect.Builder - Interface in akka.javasdk.timedaction
-
Construct the effect that is returned by the command handler.
- TimedActionClient - Interface in akka.javasdk.client
- timeout - Variable in class akka.javasdk.workflow.Workflow.StepConfig
- timeout() - Method in class akka.javasdk.workflow.Workflow.AsyncCallStep
- timeout() - Method in class akka.javasdk.workflow.Workflow.CallStep
- timeout() - Method in interface akka.javasdk.workflow.Workflow.Step
- timeout(Duration) - Method in class akka.javasdk.workflow.Workflow.AsyncCallStep
-
Define a step timeout.
- timeout(Duration) - Method in class akka.javasdk.workflow.Workflow.CallStep
-
Define a step timeout.
- timeout(Duration) - Method in class akka.javasdk.workflow.Workflow.WorkflowDef
-
Define a timeout for the duration of the entire workflow.
- timers() - Method in class akka.javasdk.consumer.Consumer
-
Returns a
TimerScheduler
that can be used to schedule further in time. - timers() - Method in class akka.javasdk.timedaction.TimedAction
-
Returns a
TimerScheduler
that can be used to schedule further in time. - timers() - Method in class akka.javasdk.workflow.Workflow
-
Returns a
TimerScheduler
that can be used to schedule further in time. - TimerScheduler - Interface in akka.javasdk.timer
- toString() - Method in record class akka.javasdk.http.StrictResponse
-
Returns a string representation of this record class.
- toString() - Method in class akka.javasdk.Principal.LocalService
- traceContext() - Method in interface akka.javasdk.Metadata
-
Get the trace context associated with this request metadata.
- TraceContext - Interface in akka.javasdk
-
Utility interface for trace context helper methods.
- traceId() - Method in interface akka.javasdk.TraceContext
-
Allows retrieving the trace id of the trace parent if any.
- traceParent() - Method in interface akka.javasdk.TraceContext
-
Allows retrieving the trace parent for easier injection in external calls (e.g.
- traceState() - Method in interface akka.javasdk.TraceContext
-
Allows retrieving the trace state for easier injection in external calls (e.g.
- transform(int, JsonNode) - Method in class akka.javasdk.JsonMigration
-
Implement the transformation of the incoming JSON structure to the current JSON structure.
- transitionFunc - Variable in class akka.javasdk.workflow.Workflow.AsyncCallStep
- transitionFunc - Variable in class akka.javasdk.workflow.Workflow.CallStep
- transitionInputClass - Variable in class akka.javasdk.workflow.Workflow.AsyncCallStep
- transitionInputClass - Variable in class akka.javasdk.workflow.Workflow.CallStep
- transitionTo(String) - Method in interface akka.javasdk.workflow.Workflow.Effect.Builder
-
Defines the next step to which the workflow should transition to.
- transitionTo(String) - Method in interface akka.javasdk.workflow.Workflow.Effect.PersistenceEffectBuilder
-
Defines the next step to which the workflow should transition to.
- transitionTo(String, I) - Method in interface akka.javasdk.workflow.Workflow.Effect.Builder
-
Defines the next step to which the workflow should transition to.
- transitionTo(String, I) - Method in interface akka.javasdk.workflow.Workflow.Effect.PersistenceEffectBuilder
-
Defines the next step to which the workflow should transition to.
- type() - Method in interface akka.javasdk.CloudEvent
-
The type of this CloudEvent.
- TypeName - Annotation Interface in akka.javasdk.annotations
-
Annotation to assign a logical type name to events.
U
- unauthorized() - Static method in class akka.javasdk.http.HttpException
- unauthorized(String) - Static method in class akka.javasdk.http.HttpException
- UNSPECIFIED - Enum constant in enum class akka.javasdk.annotations.Acl.Principal
- UNSPECIFIED - Enum constant in enum class akka.javasdk.annotations.JWT.JwtMethodMode
-
No validation.
- 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.
- updateRow(S) - Method in interface akka.javasdk.view.TableUpdater.Effect.Builder
- updateState(S) - Method in interface akka.javasdk.keyvalueentity.KeyValueEntity.Effect.Builder
- updateState(S) - Method in interface akka.javasdk.workflow.Workflow.Effect.Builder
V
- validate() - Element in annotation interface akka.javasdk.annotations.JWT
- value - Variable in enum class akka.javasdk.annotations.Acl.DenyStatusCode
- value() - Element in annotation interface akka.javasdk.annotations.ComponentId
- value() - Element in annotation interface akka.javasdk.annotations.Consume.FromEventSourcedEntity
-
Assign the class type of the entity one intends to consume from, which must extend
EventSourcedEntity
. - value() - Element in annotation interface akka.javasdk.annotations.Consume.FromKeyValueEntity
-
Assign the class type of the entity one intends to consume from, which must extend
KeyValueEntity
. - value() - Element in annotation interface akka.javasdk.annotations.Consume.FromTopic
-
Assign the name of the topic to consume the stream from.
- value() - Element in annotation interface akka.javasdk.annotations.http.Delete
- value() - Element in annotation interface akka.javasdk.annotations.http.Get
- value() - Element in annotation interface akka.javasdk.annotations.http.HttpEndpoint
- value() - Element in annotation interface akka.javasdk.annotations.http.Patch
- value() - Element in annotation interface akka.javasdk.annotations.http.Post
- value() - Element in annotation interface akka.javasdk.annotations.http.Put
- value() - Element in annotation interface akka.javasdk.annotations.Migration
- value() - Element in annotation interface akka.javasdk.annotations.Produce.ToTopic
-
Assign the name of the topic to be used for eventing out.
- value() - Element in annotation interface akka.javasdk.annotations.Query
-
Assigns the actual query which makes use of the enclosing entity table name as source of data for composition.
- value() - Element in annotation interface akka.javasdk.annotations.Table
-
Assign a table name.
- value() - Element in annotation interface akka.javasdk.annotations.TypeName
-
Logical type name for the annotated type.
- valueOf(String) - Static method in enum class akka.javasdk.annotations.Acl.DenyStatusCode
-
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.Principal.Basic
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class akka.javasdk.annotations.Acl.DenyStatusCode
-
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.Principal.Basic
-
Returns an array containing the constants of this enum class, in the order they are declared.
- View - Class in akka.javasdk.view
-
A service that follows the Command Query Responsibility Segregation (CQRS) pattern.
- View() - Constructor for class akka.javasdk.view.View
- View.QueryEffect<T> - Interface in akka.javasdk.view
-
Not for user extension, instances are returned through factory method {
View.queryResult()
} - View.QueryStreamEffect<T> - Interface in akka.javasdk.view
-
Not for user extension, instances are returned through factory method
View.queryStreamResult()
- ViewClient - Interface in akka.javasdk.client
-
Not for user extension
W
- withDatacontenttype(String) - Method in interface akka.javasdk.CloudEvent
-
Return a new CloudEvent with the given data content type.
- withDataschema(URI) - Method in interface akka.javasdk.CloudEvent
-
Return a new CloudEvent with the given data schema.
- withHeaders(Iterable<HttpHeader>) - Method in interface akka.javasdk.http.RequestBuilder
- withId(String) - Method in interface akka.javasdk.CloudEvent
-
Return a new CloudEvent with the given id.
- 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.DeferredCall
- 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.
- withSource(URI) - Method in interface akka.javasdk.CloudEvent
-
Return a new CloudEvent with the given source.
- withSubject(String) - Method in interface akka.javasdk.CloudEvent
-
Return a new CloudEvent with the given subject.
- withTime(ZonedDateTime) - Method in interface akka.javasdk.CloudEvent
-
Return a new CloudEvent with the given time.
- withTimeout(Duration) - Method in interface akka.javasdk.http.RequestBuilder
- withType(String) - Method in interface akka.javasdk.CloudEvent
-
Return a new CloudEvent with the given type.
- workflow() - Method in class akka.javasdk.workflow.Workflow
- Workflow<S> - Class in akka.javasdk.workflow
-
Workflows are stateful components and are defined by a set of steps and transitions between them.
- Workflow() - Constructor for class akka.javasdk.workflow.Workflow
- Workflow.AsyncCallStep<CallInput,
CallOutput, - Class in akka.javasdk.workflowFailoverInput> - Workflow.CallStep<CallInput,
DefCallInput, - Class in akka.javasdk.workflowDefCallOutput, FailoverInput> - Workflow.Effect<T> - Interface in akka.javasdk.workflow
-
An Effect is a description of what the runtime needs to do after the command is handled.
- Workflow.Effect.Builder<S> - Interface in akka.javasdk.workflow
-
Construct the effect that is returned by the command handler or a step transition.
- Workflow.Effect.PersistenceEffectBuilder<T> - Interface in akka.javasdk.workflow
- Workflow.Effect.TransitionalEffect<T> - Interface in akka.javasdk.workflow
-
A workflow effect type that contains information about the transition to the next step.
- Workflow.ReadOnlyEffect<T> - Interface in akka.javasdk.workflow
-
An effect that is known to be read only and does not update the state of the entity.
- Workflow.RecoverStrategy<T> - Class in akka.javasdk.workflow
- Workflow.RecoverStrategy.MaxRetries - Class in akka.javasdk.workflow
-
Retry strategy without failover configuration
- Workflow.Step - Interface in akka.javasdk.workflow
- Workflow.StepConfig - Class in akka.javasdk.workflow
- Workflow.WorkflowDef<S> - Class in akka.javasdk.workflow
- WorkflowClient - Interface in akka.javasdk.client
-
Not for user extension
- WorkflowContext - Interface in akka.javasdk.workflow
- workflowId() - Method in interface akka.javasdk.workflow.CommandContext
-
The id of the workflow that this context is for.
- workflowId() - Method in interface akka.javasdk.workflow.WorkflowContext
-
The id of the workflow that this context is for.
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form