Client
View as MarkdownThis page lists the Go SDK names for the Client. The doc comment of each API gives its parameters, defaults, and errors. Read them in the Go SDK API reference.
API names
| Task | Go API | Dex behavior |
|---|---|---|
| Create a Client | NewClient, with ClientOptions. It returns a Client. | Client requests |
| Start a Flow | StartFlow, with StartFlowOptions | Start a Flow |
| Invoke an RPC | InvokeRPC | Invoke an RPC |
| Read Attributes | GetAttributes | Read Attributes |
| Wait for a Flow to close | WaitForFlow, with WaitForFlowOptions | 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 StopOptions | 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 |
| Time travel a Flow | TimeTravel, with TimeTravelOptions | Time travel |
| Handle a failed request | ServiceError, with ErrorSubStatus | Client requests |
Every Client method that calls Dex Server takes a context.Context as its first argument. Canceling a wait ends the call. It does not stop the Flow.