Run Stream
datastream.run_stream
ActionGoogle Cloudconnection required
Calls Datastream POST /v1/projects/{projectsId}/locations/{locationsId}/streams/{streamsId}:run.
Use this method to start, resume or recover a stream with a non default CDC strategy.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- OAuth 2.0
- Providers
- Google Datastream
- Secret shape
- {"client_id", "client_secret", "refresh_token"}
- Config it needs
- location, project_id
- Resolved by
- config.connection_id, else node.connection_id
Configuration
4 fields, 1 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
project_id GCP project id (overrides connection). | string | No | — | — | — |
location Location / region (overrides connection). | string | No | — | — | — |
stream Id of the stream to act on, from datastream.list_streams — not its name. | string | Yes | — | — | — |
body Request body (RunStreamRequest) as JSON. | object | No | — | — | — |
Output
One shape.
result
| Field | Type | Example |
|---|---|---|
ok | boolean | — |
done | boolean | — |
metadata | object | — |
response | object | — |
error | object | — |
name | string | — |
{
"done": false,
"error": {},
"metadata": {},
"name": "",
"ok": false,
"response": {}
}See Run Stream run in a workflow.
In a technical demo we add the Google Datastream connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.