Package com.hivemq.extensions.amazon.kinesis.api.transformers

Interface MqttToKinesisOutput

@DoNotImplement
public interface MqttToKinesisOutput

The output parameter of the MqttToKinesisTransformer. It allows access to the OutboundKinesisRecordBuilder.

After the MqttToKinesisTransformer.transformMqttToKinesis(MqttToKinesisInput, MqttToKinesisOutput) method returns the OutboundKinesisRecords given to this output will be published to Amazon Kinesis by the HiveMQ Enterprise Extension for Amazon Kinesis.

Since:

4.14.0

Method Summary

Modifier and Type	Method	Description
@NotNull OutboundKinesisRecordBuilder	newOutboundKinesisRecordBuilder()	Create a new OutboundKinesisRecordBuilder.
void	setOutboundKinesisRecords(@NotNull List<@NotNull OutboundKinesisRecord> outboundKinesisRecords)	Sets the OutboundKinesisRecords, that will be pushed to Amazon Kinesis after the MqttToKinesisTransformer.transformMqttToKinesis(MqttToKinesisInput, MqttToKinesisOutput) call returns.

Method Detail

newOutboundKinesisRecordBuilder

@NotNull
@NotNull OutboundKinesisRecordBuilder newOutboundKinesisRecordBuilder()

Create a new OutboundKinesisRecordBuilder. A single OutboundKinesisRecordBuilder can be used to build multiple Amazon Kinesis records.

Returns:

An empty instance of the OutboundKinesisRecordBuilder.

Since:

4.14.0

setOutboundKinesisRecords

void setOutboundKinesisRecords(@NotNull
                               @NotNull List<@NotNull OutboundKinesisRecord> outboundKinesisRecords)

Sets the OutboundKinesisRecords, that will be pushed to Amazon Kinesis after the MqttToKinesisTransformer.transformMqttToKinesis(MqttToKinesisInput, MqttToKinesisOutput) call returns. The "HiveMQ Enterprise Extension for Amazon Kinesis" will publish the records in the order provided by the outboundKinesisRecords argument.

If desired, the same records can occupy multiple places in the outboundKinesisRecords list. When no record shall be pushed to Amazon Kinesis for a given PublishPacket, provide an empty list or just don't call this method.

Use the OutboundKinesisRecordBuilder to create new records as desired.

Each additional call of this method will overwrite the previous one.

Parameters:

outboundKinesisRecords - A list of to be published OutboundKinesisRecords.

Throws:

NullPointerException - If outboundKinesisRecords or any element of it is null.

IllegalArgumentException - If any element in outboundKinesisRecords was not created via a OutboundKinesisRecordBuilder.

Since:

4.14.0