Client
View as MarkdownThis page lists the Java SDK names for the Client. The doc comment of each API gives its parameters, defaults, and errors. Read them in the Java SDK API reference.
API names
| Task | Java API | Dex behavior |
|---|---|---|
| Create a Client | Client, from a Registry and a BlobCache, with ClientOptions | Client requests |
| Start a Flow | startFlow, with StartFlowOptions | Start a Flow |
| Invoke an RPC | invokeRPC, on a stub from newRpcStub | Invoke an RPC |
| Read Attributes | getAttributes | Read Attributes |
| Wait for a Flow to close | waitForFlow | Wait for a Flow |
| Wait for a Step execution to complete | waitForStepCompletion, with WaitForStepCompletionOptions | Wait for a Step |
| Wait until an Attribute matches | waitForAttributeMatch, with WaitForAttributeOptions | Wait for an Attribute match |
| Describe a Flow | describeFlow | Describe a Flow |
| Search Flows | searchFlows | Search Flows |
| Stop a Flow | stopFlow, with StopFlowOptions | Stop a Flow |
| Skip a Timer | skipTimer | Skip a Timer |
| Update FlowConfig | updateFlowConfig | Update FlowConfig |
| Write and read a Stream | writeStream, readStream, and listStreamMessages | Stream |
| Upload Flow definitions | uploadFlowDefinitions, with FlowDefinitionDocument; returns FlowDefinitionUploadResult values. Since 1.45.0 | Flow definitions |
| Time travel a Flow | timeTravel, with TimeTravelOptions | Time travel |
| Handle a failed request | DexServiceException, with ErrorSubStatus | Client requests |
Every network method of Client blocks the calling thread until the request completes. Create one Client and reuse it across calls. Client is AutoCloseable. Closing it does not close the BlobCache.
Example
Example: examples/java/src/main/java/io/superdurable/dex/primitives/clientapis/ClientApisController.java