Package dev.restate.sdk

Interface SharedObjectContext

All Superinterfaces:

Context

All Known Subinterfaces:

ObjectContext, SharedWorkflowContext, WorkflowContext

public interface SharedObjectContext
extends Context

This interface can be used only within shared handlers of virtual objects. It extends Context adding access to the virtual object instance key-value state storage.

NOTE: This interface MUST NOT be accessed concurrently since it can lead to different orderings of user actions, corrupting the execution of the invocation.

See Also:

• Context

Method Summary

Modifier and Type	Method	Description
<T> Optional<T>	get(StateKey<T> key)	Gets the state stored under key, deserializing the raw value using the Serde in the StateKey.
String	key()
Collection<String>	stateKeys()	Gets all the known state keys for this virtual object instance.

Methods inherited from interface dev.restate.sdk.Context

awakeable, awakeable, awakeableHandle, call, invocationHandle, invocationHandle, invocationHandle, random, request, run, run, run, run, run, run, run, run, run, runAsync, runAsync, runAsync, runAsync, runAsync, runAsync, runAsync, runAsync, runAsync, send, send, sleep, timer, timer

Method Details

key

String key()

Returns:

the key of this object

get

<T> Optional<T> get(StateKey<T> key)

Gets the state stored under key, deserializing the raw value using the Serde in the StateKey.

Parameters:

key - identifying the state to get and its type.

Returns:

an Optional containing the stored state deserialized or an empty Optional if not set yet.

Throws:

RuntimeException - when the state cannot be deserialized.

stateKeys

Collection<String> stateKeys()

Gets all the known state keys for this virtual object instance.

Returns:

the immutable collection of known state keys.