Stream Processor APIs
The Stream Processor has two supported programming interfaces for writing streaming applications, one in q and one in Python.
To interact with the Stream Processor at runtime, refer to the OpenAPI REST interface.
- Coordinator OpenAPI This is the primary interface for interacting
with the Stream Processor. Use the Coordinator interface to deploy and teardown pipelines.
This interface is available using a Kubernetes service name
- Controller OpenAPI The controller interface offers localized feedback on a single pipeline. This interface is only accessible in a microservice deployment or using a port forward in a platform deployment.
- Worker OpenAPI The worker interface allows for introspection of the runtime state of a given worker. This interface is only accessible in a microservice deployment or using a port forward in a platform deployment.
Code that is marked as
deprecated is subject to be removed in the next major release. Deprecated
APIs will be maintained for all minor versions of a release but will print a warning indicating
that they are deprecated. All deprecated APIs will indicate a path for upgrade in the relevant
documentation. See the release notes for details on any deprecated
or removed APIs.