search

IBMStreams / streamsx.messagehub

Repository to provide easy integration with IBM MessageHub Bluemix Service
https://ibmstreams.github.io/streamsx.messagehub/
Apache License 2.0
1 stars 6 forks source link

SPLDoc: MessageHubConsumer references wrong functions in input port description #99

Closed ghost closed 5 years ago

ghost commented 5 years ago

SPLDoc:

The following types and convenience functions are available to aid in creating the messages:

type Control.TopicPartition = rstring topic, int32 partition;
type Control.TopicPartitionOffset = rstring topic, int32 partition, int64 offset;
rstring addTopicPartitionMessage (rstring topic, int32 partition, int64 offset);
rstring addTopicPartitionMessage (rstring topic, int32 partition);
rstring addTopicPartitionMessage (list<Control.TopicPartitionOffset> topicPartitionsToAdd);
rstring addTopicPartitionMessage (list<Control.TopicPartition> topicPartitionsToAdd);
rstring removeTopicPartitionMessage (rstring topic, int32 partition);
rstring removeTopicPartitionMessage (list<Control.TopicPartition> topicPartitionsToRemove);

The functions declared by this toolkit are:

    createMessageAddTopicPartition(list<Control.TopicPartition>): Creates the JSON message to add multiple topic-partitions to the operator.
    createMessageAddTopicPartition(list<Control.TopicPartitionOffset>): Creates the JSON message to add multiple topic-partitions to the operator.
    createMessageAddTopicPartition(rstring, int32): Creates the JSON message to add a single topic-partition to the operator 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 and to begin consuming at the specified offset.
    createMessageRemoveTopicPartition(list<Control.TopicPartition>): Creates the JSON message to remove multiple topic-partitions from the operator.
    createMessageRemoveTopicPartition(rstring, int32): Creates the JSON message to remove a single topic-partition from the operator.