streamsx.rest module¶

Python API that wraps the REST apis for IBM® Streams & IBM Streaming Analytics service on IBM Bluemix®.

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.

StreamsConnection is the entry point to using the Streams REST API from Python. 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 the Bluemix applications that are bound to your service instance or from an application outside of Bluemix 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 addtion StreamingAnalyticsConnection extends from StreamsConnection and thus provides access to the Streams REST API for the service instance.

See also

IBM Streams REST API overview: Reference documentation for the Streams REST API.
Streaming Analytics REST API: Reference documentation for the Streaming Analytics service REST API.

class streamsx.rest.StreamingAnalyticsConnection(vcap_services=None, service_name=None)¶

Bases: streamsx.rest.StreamsConnection

Creates a connection to a running Streaming Analytics service and exposes methods to retrieve the state of the service and its instance.

Parameters:	vcap_services (str, optional) – VCAP services (JSON string or a filename whose content contains a JSON string). If not specified, it uses the value of VCAP_SERVICES environment variable. service_name (str, optional) – Name of the Streaming Analytics service. If not specified, it uses the value of STREAMING_ANALYTICS_SERVICE_NAME environment variable.

Example

>>> # Assume environment variable VCAP_SERVICES has correct information
>>> sc = StreamingAnalyticsConnection(service_name='Streaming-Analytics')
>>> print(sc.get_streaming_analytics().get_instance_status())
{'plan': 'Standard', 'state': 'STARTED', 'enabled': True, 'status': 'running'}

get_domain(id)¶

Retrieves available domain matching a specific domain ID

Parameters:	id (str) – domain ID
Returns:	Domain matching id
Return type:	`Domain`
Raises:	`ValueError` – No matching domain exists.

get_domains()¶

Retrieves available domains.

Returns:	List of available domains
Return type:	`list` of `Domain`

get_installations()¶

Retrieves a list of all known Streams installations.

Returns:	List of all Installation resources.
Return type:	`list` of `Installation`

get_instance(id)¶

Retrieves available instance matching a specific instance ID.

Parameters:	id (str) – Instance identifier to retrieve.
Returns:	Instance matching id.
Return type:	`Instance`
Raises:	`ValueError` – No matching instance exists or multiple matching instances exist.

get_instances()¶

Retrieves available instances.

Returns:	List of available instances
Return type:	`list` of `Instance`

get_resources()¶

Retrieves a list of all known Streams resources.

Returns:	List of all Streams resources.
Return type:	`list` of `Resource`

get_streaming_analytics()¶

Returns a StreamingAnalyticsService to allow further interaction with the Streaming Analytics service.

Returns:	Object for interacting with the Streaming Analytics service.
Return type:	`StreamingAnalyticsService`

resource_url¶: str – Root URL for IBM Streams REST API

class streamsx.rest.StreamsConnection(username=None, password=None, resource_url=None)¶

Bases: object

Creates a connection to a running distributed IBM Streams instance and exposes methods to retrieve the state of that instance.

Streams maintains information regarding the state of its resources. For example, these resources could include the currently running Jobs, Views, PEs, Operators, and Domains. The StreamsConnection provides methods to retrieve that information.

Parameters:	username (str) – Username of an authorized Streams user. password (str) – Password for username resource_url (str, optional) – Root URL for IBM Streams REST API.