streamsx.rest¶

REST API bindings for IBM® Streams & Streaming Analytics service.

Streams REST API¶

The Streams REST API provides programmatic access to configuration and status information for IBM Streams objects such as domains, instances, and jobs.

IBM Cloud Pak for Data (Streams 5)¶

Integrated configuration within project¶

of_service() is the entry point to using the Streams REST API bindings, returning an Instance. The configuration required to connect is obtained from ipcd_util.get_service_details passing in the IBM Streams service instance name.

Integrated & standalone configurations¶

of_endpoint() is the entry point to using the Streams REST API bindings, returning an Instance.

IBM Streams On-premises (4.2, 4.3)¶

StreamsConnection is the entry point to using the Streams REST API bindings. Through its functions and the returned objects status information can be obtained for items such as instances and jobs.

Streaming Analytics REST API¶

You can use the Streaming Analytics REST API to manage your service instance and the IBM Streams jobs that are running on the instance. The Streaming Analytics REST API is accessible from IBM Cloud applications that are bound to your service instance or from an application outside of IBM Cloud that is configured with the service instance VCAP information.

StreamingAnalyticsConnection is the entry point to using the Streaming Analytics REST API. The function get_streaming_analytics() returns a StreamingAnalyticsService instance which is the wrapper around the Streaming Analytics REST API. This API allows functions such as start and stop the service instance.

In addition StreamingAnalyticsConnection extends from StreamsConnection and thus provides access to the Streams REST API for the service instance.

Module contents¶

Classes

`StreamingAnalyticsConnection`	Creates a connection to a running Streaming Analytics service and exposes methods to retrieve the state of the service and its instance.
`StreamsConnection`	Creates a connection to a running distributed IBM Streams instance and exposes methods to retrieve the state of that instance.