Home
Reference
Find details on the SPL language, toolkits, APIs, commands, and more.
APIs
Application programming interfaces (APIs) provide functions that simplify applications development.
REST management API
The REST management API provides programmatic access to configuration and management for Streams objects such as the domain, instances, resources, services and jobs. You can use the REST management API from any application that can establish an HTTPS connection to the server that is running the REST management API service.

Welcome
Learn about the core capabilities of Teracloud® Streams, its architecture, and key concepts.
Installing
Use this information to install, upgrade, and uninstall the Teracloud® Streams product.
Configuring
Create a basic or an enterprise domain which is a single point for configuring and managing common resources, security, and instances.
Administering
Administer the product by using the Teracloud® Streams graphical user interface, APIs, or the streamtool command-line interface.
Developing
Learn about different Teracloud Streams tools and features to write, compile, run, and test streams applications.
Troubleshooting
Resolve problems with Teracloud® Streams using the troubleshooting tools provided with the product as well as the resources offered by Teracloud Support.
Reference
Find details on the SPL language, toolkits, APIs, commands, and more.
- APIs
  Application programming interfaces (APIs) provide functions that simplify applications development.
  - JMX management API
    Teracloud® Streams provides an application programming interface (API) for managing domains, instances, resources, jobs, and object permissions. This API is a Java™ Management Extensions (JMX) implementation.
  - REST management API
    The REST management API provides programmatic access to configuration and management for Streams objects such as the domain, instances, resources, services and jobs. You can use the REST management API from any application that can establish an HTTPS connection to the server that is running the REST management API service.
    - REST management API
  - Security SPI
    Teracloud® Streams provides a service provider interface (SPI) for user-defined login modules.
  - SPL Java Operator API
    Java Operator API for Streams. The Java Operator API provides the ability to develop operators and functions for use in Streams Processing Language (SPL).
  - SPL Operator Code Generation API
    The SPL Operator Code Generation API is used to develop generic SPL primitive operators using code generator templates (.cgt files), in order to achieve a level of reusability and genericity that is not available to SPL primitive operators written in pure C++ or Java.
  - SPL Operator Runtime C++ API
    SPL Runtime C++ APIs are used to develop SPL primitive operators in C++ and native functions in C++.
- Job configuration overlays
  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.
- Commands
  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
  An operator model is an XML document that describes the basic properties of a primitive operator.
- Streams Processing Language (SPL)
  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.
Glossary
Use this glossary to find terms and definitions for Teracloud® Streams.

REST management API reference

The REST management API provides programmatic access to configuration and management for Streams objects such as the domain, instances, resources, services and jobs. You can use the REST management API from any application that can establish an HTTPS connection to the server that is running the REST management API service.