Home
Reference
Find details on the SPL language, toolkits, APIs, commands, and more.
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.
Toolkits
Toolkit com.teracloud.streams.objectstorage 4.0.0

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
Develop stream applications with the Streams Processing Language (SPL), Java, and Python.
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.
- 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.
- 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.
  - Specialized toolkit requirements and restrictions
    Several of the specialized toolkits require RPMs that are not required by the Teracloud® Streams product. There are also toolkit restrictions on some platforms.
  - Toolkits
- 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.

Toolkit com.teracloud.streams.objectstorage 4.0.0

General Information

The Object Storage toolkit is a Streams toolkit that helps you integrate Streams with IBM Cloud Object Storage.

The operators provide the ability for Streams applications to write and read objects to and from object storage.

The operators support IBM Cloud Object Storage and S3-compatible object storages. Connection information needs to be specified with operator parameters or application configuration.

The toolkit contains two namespaces:

com.teracloud.streams.objectstorage
com.teracloud.streams.objectstorage.s3

Operators in the com.teracloud.streams.objectstorage use generic parameters while the operators in the com.teracloud.streams.objectstorage.s3 namespace use S3-compliant authentication and connection parameters. For example, ObjectStorageSink uses a objectStorageURI parameter which consists of protocol and bucket name (s3a://<BUCKET_NAME>/), rather S3ObjectStorageSink operator uses S3-compliant parameter names such as protocol and bucket as a separate parameters making it more intuitive for the users familiar with S3 COS terms.

Note: other operator parameter groups (except of authentication and connection) are exactly the same for both operators.

Release notes

Using the toolkit with IBM Cloud Object Storage

Developing and running applications that use the ObjectStorage Toolkit

Protocol (client) selection

Version: 4.0.0
Required Product Version: 7.2.0.0

Indexes


Namespaces
Operators
Functions

Namespaces

com.teracloud.streams.objectstorage

Contains operators that support generic URI specification for COS protocol and bucket usage.

Operators

com.teracloud.streams.objectstorage.s3

Operators

Functions