Home
Reference
Find details on the SPL language, toolkits, APIs, commands, and more.
Operator model
An operator model is an XML document that describes the basic properties of a primitive operator.
Java™ operator model
An operator model is an XML document that describes the basic properties of a primitive operator. You can use annotations in your Java™ source code to describe the operator model for Java operators. For more information about creating a Java operator model, see the API documentation for the com.ibm.streams.function.model package.
The execution settings
The executionSettings element is part of the context element of the operator model. The executionSettings element is after the metrics element within the context element. It describes the execution settings of the operator.

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.
- 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.
  - C++ operator model
    An operator model is an XML document that describes the basic properties of a primitive operator.
  - Java™ operator model
    An operator model is an XML document that describes the basic properties of a primitive operator. You can use annotations in your Java™ source code to describe the operator model for Java operators. For more information about creating a Java operator model, see the API documentation for the com.ibm.streams.function.model package.
    - The execution settings
      The executionSettings element is part of the context element of the operator model. The executionSettings element is after the metrics element within the context element. It describes the execution settings of the operator.
    - Differences from the C++ operator models
      A number of elements are not allowed in Java™ operator models, but they can appear in C++ operator models.
- 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.

The execution settings

The executionSettings element is part of the context element of the operator model. The executionSettings element is after the metrics element within the context element. It describes the execution settings of the operator.

Listing 18: Execution settings type as part of the operator context

Listing 18 gives the basic structure.

<xs:complexTypename="javaOpContextType">
  <xs:sequence>
    ...
    <xs:element name="metrics" type="metricsType" minOccurs="0" maxOccurs="1"/>
    <xs:element name="executionSettings" type="javaOpExecutionSettingsType"/>
  </xs:sequence>
</xs:complexType>
          
<xs:complexType name="javaOpExecutionSettingsType">
  <xs:sequence>
    <xs:element name="className" type=xs:token"/>
    <xs:element name="vmArgs" type="javaOpVMArgsType" minOccurs="0" maxOccurs="1"/>
  </xs:sequence>
</xs:complexType>
            
<xs:complexType name="javaOpVMArgsType">
  <xs:sequence>
    <xs:element name="vmArg" type="xs:string" minOccurs="0' 'maxOccurs="unbounded"/>
  </xs:sequence>
</xs:complexType>

The executionSettings element contains two subelements: className and vmArgs. The className element specifies the name of the class that represents the operator. The vmArgs element specifies the set of JVM arguments that are required by the operator.

Listing 19: Sample execution settings XML segment

Listing 19 gives a sample XML segment for the execution settings.

<executionSettings>
  <className>com.acme.streams.MyOp</className>
  <vmArgs>
    <vmArg>-Dfoo=true</vmArg>
    <vmArg>-Xmx32m</vmArg>
  </vmArgs>
<executionSettings>

In the example that is given in Listing 19, the className element specifies the namespace qualified class name for the operator. The path to the .jar file or the directory that contains the class files is specified as part of the libraryDependencies element, described in the next section.