Start (resume) or pause the input connector.
The following values of the action argument are accepted: start and pause.
Input connectors can be in either the Running or Paused state. By default,
connectors are initialized in the Running state when a pipeline is deployed.
In this state, the connector actively fetches data from its configured data
source and forwards it to the pipeline. If needed, a connector can be created
in the Paused state by setting its
paused property
to true. When paused, the connector remains idle until reactivated using the
start command. Conversely, a connector in the Running state can be paused
at any time by issuing the pause command.
The current connector state can be retrieved via the
GET /v0/pipelines/{pipeline_name}/stats endpoint.
Note that only if both the pipeline and the connector state is Running,
is the input connector active.
Pipeline state Connector state Connector is active?
-------------- --------------- --------------------
Paused Paused No
Paused Running No
Running Paused No
Running Running Yes
| Path Parameters |
|---|
pipeline_name string — REQUIREDUnique pipeline name |
table_name string — REQUIREDUnique table name |
connector_name string — REQUIREDUnique input connector name |
action string — REQUIREDInput connector action (one of: start, pause) |
| Responses | ||||
|---|---|---|---|---|
200Action has been processed | ||||
404Pipeline, table and/or input connector with that name does not exist
| ||||
500
| ||||
503
|