---
title: "Client"
description: "This page lists the Java SDK names for the Client."
canonical_url: "https://docs.superdurable.io/reference/java/client/"
source: "docs/reference/java/client.mdx"
locale: "en"
---

# Client

This page lists the Java SDK names for the [Client](https://docs.superdurable.io/concepts/client.md).
The doc comment of each API gives its parameters, defaults, and errors. Read
them in the [Java SDK API reference](https://docs.superdurable.io/reference/java.md#api-reference).

<a id="api-names"></a>

## API names

| Task                                  | Java API                                                                                                                | Dex behavior                                                                                                               |
| ------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
| Create a Client                       | **Client**, from a **Registry** and a **BlobCache**, with **ClientOptions**                                             | [Client requests](https://docs.superdurable.io/reference/server/runtime-client.md)                                         |
| Start a Flow                          | **startFlow**, with **StartFlowOptions**                                                                                | [Start a Flow](https://docs.superdurable.io/reference/server/runtime-client.md#start-a-flow)                               |
| Invoke an RPC                         | **invokeRPC**, on a stub from **newRpcStub**                                                                            | [Invoke an RPC](https://docs.superdurable.io/reference/server/runtime-client.md#invoke-an-rpc)                             |
| Read Attributes                       | **getAttributes**                                                                                                       | [Read Attributes](https://docs.superdurable.io/reference/server/runtime-client.md#read-attributes)                         |
| Wait for a Flow to close              | **waitForFlow**                                                                                                         | [Wait for a Flow](https://docs.superdurable.io/reference/server/runtime-client.md#wait-for-a-flow)                         |
| Wait for a Step execution to complete | **waitForStepCompletion**, with **WaitForStepCompletionOptions**                                                        | [Wait for a Step](https://docs.superdurable.io/reference/server/runtime-client.md#wait-for-a-step)                         |
| Wait until an Attribute matches       | **waitForAttributeMatch**, with **WaitForAttributeOptions**                                                             | [Wait for an Attribute match](https://docs.superdurable.io/reference/server/runtime-client.md#wait-for-an-attribute-match) |
| Describe a Flow                       | **describeFlow**                                                                                                        | [Describe a Flow](https://docs.superdurable.io/reference/server/runtime-client.md#describe-a-flow)                         |
| Search Flows                          | **searchFlows**                                                                                                         | [Search Flows](https://docs.superdurable.io/reference/server/runtime-client.md#search-flows)                               |
| Stop a Flow                           | **stopFlow**, with **StopFlowOptions**                                                                                  | [Stop a Flow](https://docs.superdurable.io/reference/server/runtime-client.md#stop-a-flow)                                 |
| Skip a Timer                          | **skipTimer**                                                                                                           | [Skip a Timer](https://docs.superdurable.io/reference/server/runtime-client.md#skip-a-timer)                               |
| Update FlowConfig                     | **updateFlowConfig**                                                                                                    | [Update FlowConfig](https://docs.superdurable.io/reference/java/flow.md#update-flow-config-with-a-client)                  |
| Write and read a Stream               | **writeStream**, **readStream**, and **listStreamMessages**                                                             | [Stream](https://docs.superdurable.io/reference/java/stream.md)                                                            |
| Upload Flow definitions               | **uploadFlowDefinitions**, with **FlowDefinitionDocument**; returns **FlowDefinitionUploadResult** values. Since 1.45.0 | [Flow definitions](https://docs.superdurable.io/reference/server/runtime-client.md#flow-definitions)                       |
| Time travel a Flow                    | **timeTravel**, with **TimeTravelOptions**                                                                              | [Time travel](https://docs.superdurable.io/reference/server/runtime-client.md#time-travel)                                 |
| Handle a failed request               | **DexServiceException**, with **ErrorSubStatus**                                                                        | [Client requests](https://docs.superdurable.io/reference/server/runtime-client.md)                                         |

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**.

<a id="example"></a>

## Example

Example: [examples/java/src/main/java/io/superdurable/dex/primitives/clientapis/ClientApisController.java](https://github.com/superdurable/dex/tree/main/examples/java/src/main/java/io/superdurable/dex/primitives/clientapis/ClientApisController.java)