Namespace com.ibm.streamsx.messagehub

Message Hub (Event Streams) Toolkit > com.ibm.streamsx.messagehub 3.3.1 > com.ibm.streamsx.messagehub

This SPL namespace contains the operators to connect with an instance of the IBM Event Streams cloud service. These operators are based on the operators of the streamsx.kafka toolkit. It is recommended that users review the Kafka Toolkit documentation for additional information on supported functionality. The Kafka Toolkit documentation can be found here: Kafka Toolkit

Setup of the operators

Tracing Kafka properties

Operators

• MessageHubConsumer: The MessageHubConsumer operator is used to consume records from the IBM Event Streams cloud service.
• MessageHubProducer: The MessageHubProducer operator is used to consume records from the IBM Event Streams cloud service.

Functions

• createMessageAddTopic(rstring): Creates the JSON message to add a single topic to the operator's subscription to begin consuming from the default position.
• createMessageAddTopicPartition(list<Control.TopicPartition>): Creates the JSON message to add multiple topic partitions to the operator's partition assignment.
• createMessageAddTopicPartition(list<Control.TopicPartitionOffset>): Creates the JSON message to add multiple topic partitions to the operator's partition assignment.
• createMessageAddTopicPartition(rstring, int32): Creates the JSON message to add a single topic partition to the operator's partition assignment and to begin consuming at the default position.
• createMessageAddTopicPartition(rstring, int32, int64): Creates the JSON message to add a single topic partition to the operator's partition assignment and to begin consuming at the specified offset.
• createMessageAddTopics(list<rstring>): Creates the JSON message to add multiple topics to the operator's subscription to begin consuming from the default position.
• createMessageRemoveTopic(rstring): Creates the JSON message to remove a single topic from the operator's subscription.
• createMessageRemoveTopicPartition(list<Control.TopicPartition>): Creates the JSON message to remove multiple topic partitions from the operator's partition assignment.
• createMessageRemoveTopicPartition(rstring, int32): Creates the JSON message to remove a single topic partition from the operator's partition assignment.
• createMessageRemoveTopics(list<rstring>): Creates the JSON message to remove multiple topics from the operator's subscription.

Types

• Control.TopicPartition: Tuple type for a topic partition to be added or removed
• Control.TopicPartitionOffset: Tuple type for a topic partition with offset to be added
• MessageType.BlobMessage: This type represents a message with message attribute of type blob and key attribute with SPL type rstring.
• MessageType.ConsumerMessageMetadata: This type represents the meta data of a received message.
• MessageType.StringMessage: This type represents a message with message and key attribute, both being rstring.
• MessageType.TopicPartition: This type represents a topic and a partition number.