SPL File Functions.spl
Specialized toolkits - release 4.3.1.0-prod20190605 > com.ibm.streamsx.messagehub 1.9.3 > com.ibm.streamsx.messagehub > Functions.spl
Content
- Functions
-
- 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.
Functions
rstring createMessageRemoveTopicPartition(list<Control.TopicPartition> topicPartitionsToRemove)
Creates the JSON message to remove multiple topic-partitions from the operator.
Parameters
- topicPartitionsToRemove: specifies a list of topic partitions to remove
Returns
- A JSON string to be submitted to the KafkaConsumer input port
rstring createMessageAddTopicPartition(list<Control.TopicPartitionOffset> topicPartitionsToAdd)
Creates the JSON message to add multiple topic-partitions to the operator. The operator will begin consuming from the topic-partitions at their specified offset.
- To begin consuming from the end of a topic-partition, set the offset value to -1
- To begin consuming from the beginning of a topic-partition, set the offset value to -2
- To begin consuming from the default position, set the offset value to -3
Parameters
- topicPartitionsToAdd: A list of topic-partitions to subscribe to along with the corresponding offset number to begin consuming from.
Returns
- A JSON string to be submitted to the KafkaConsumer input port
rstring createMessageAddTopicPartition(list<Control.TopicPartition> topicPartitionsToAdd)
Creates the JSON message to add multiple topic-partitions to the operator. The operator will begin consuming all partitions from the default positions.
Parameters
- topicPartitionsToAdd: A list of topic-partitions to assign.
Returns
- A JSON string to be submitted to the KafkaConsumer input port
rstring createMessageRemoveTopicPartition(rstring topic, int32 partition)
Creates the JSON message to remove a single topic-partition from the operator.
Parameters
- topic: The topic to unsubscribe from
- partition: The partition to unsubscribe from
Returns
- A JSON string to be submitted to the KafkaConsumer input port
rstring createMessageAddTopicPartition(rstring topic, int32 partition, int64 offset)
Creates the JSON message to add a single topic-partition to the operator and to begin consuming at the specified offset.
- To begin consuming from the end of a topic-partition, set the offset value to -1
- To begin consuming from the beginning of a topic-partition, set the offset value to -2
- To begin consuming from the default position, set the offset value to -3
Parameters
- topic: The topic to subscribe to
- partition: The partition number to assign to
- offset: The offset of the topic-partition to begin consuming from
Returns
- A JSON string to be submitted to the KafkaConsumer input port
rstring createMessageAddTopicPartition(rstring topic, int32 partition)
Creates the JSON message to add a single topic-partition to the operator and to begin consuming at the default position.
Parameters
- topic: The topic to subscribe to
- partition: The partition number to assign to
Returns
- A JSON string to be submitted to the KafkaConsumer input port