API Reference

Details about the libraries made available to tests through use of the StreamSets Test Framework are documented below. These APIs can be divided into those related to StreamSets Data Collector, StreamSets Transformer, StreamSets Control Hub, Environments, and Utility functions.

StreamSets Data Collector

Main interface

Models

Fixtures

StreamSets Control Hub

Main interface

Models

Fixtures

StreamSets Transformer

Main interface

Models

Fixtures

Common for StreamSets Data Collector, Transformer and Control Hub

Environments - Core APIs

Environment abstractions to interact with InfluxDB.

class streamsets.testframework.environments.influxdb.InfluxDBInstance(uri)

Class that encapsulates InfluxDB client instance.

Parameters

uri (str) – InfluxDB URI in scheme://[username:password]@host:port[/[database]] format where scheme is one of influxdb or https+influxdb or udp+influxdb (e.g. influxdb://sdcuser:sdcpass@myinfluxdb.cluster:8086/testdb).

property client

Get a InfluxDB client.

Returns

(influxdb.InfluxDBClient)

drop_measurement(measurement)

Drop a measurement from InfluxDB.

Parameters

measurement (str) –

Returns

results (influxdb.resultset.ResultSet)

Environments - Factories

Fixtures

System models

Utility functions