- API reference
Application programming interfaces (APIs) provide functions that simplify applications development.
- Job configuration overlays reference
You can specify or change configuration parameters when you use the submitjob
or updateoperators
operations. The settings control submission constraints, host constraints and locations, and operator status. Parameters are captured and updated in the configuration JSON file. When you change the values in the job configuration overlay file, the changes override any previously set values.
- Command reference
Teracloud® Streams provides a number of commands you use to perform tasks.
- Metrics
Teracloud® Streams provides metrics to help evaluate the health of Teracloud® Streams services, to aid in diagnosing performance issues, and to analyze throughput of requests. You can use the streamtool checkinstancemetrics, streamtool checkdomainmetrics, streamtool getdomainmetrics, and streamtool checkresourcemetrics commands to view the metrics data.
- Operator model reference
An operator model is an XML document that describes the basic properties of a primitive operator.
- Streams Processing Language (SPL) reference
Streams Processing Language (SPL) is a distributed data flow composition language that is used in Teracloud® Streams. SPL has primitive types, program structures, and definitions that are tailored for streaming data.
- SPL Compiler
The SPL compiler is an incremental compiler that generates artifacts needed to run your stream application. These artifacts include, for example, C++ code for several entities in your SPL program and an application bundle file.
- Toolkits
A toolkit is a set of SPL artifacts, which are organized into a package. Toolkits make SPL or native functions and primitive or composite operators reusable across different applications.
- SPLDOC markup
You can use SPLDOC markup in the descriptions associated with the SPL artifacts in a toolkit. The spl-make-doc command generates HTML documentation from the marked up artifacts.