com.hivemq.extensions.amazon.kinesis.api.transformers.MqttToKinesisInput Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of hivemq-amazon-kinesis-extension-customization-sdk Show documentation

SDK for the development of HiveMQ Amazon Kinesis Extension customizations

There is a newer version: 4.32.0

Show newest version

/*
 * Copyright 2023-present HiveMQ GmbH
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.hivemq.extensions.amazon.kinesis.api.transformers;

import com.hivemq.extension.sdk.api.annotations.DoNotImplement;
import com.hivemq.extension.sdk.api.annotations.NotNull;
import com.hivemq.extension.sdk.api.packets.publish.PublishPacket;

/**
 * The input parameter of the {@link MqttToKinesisTransformer}. It contains the information of the {@link PublishPacket}
 * to be transformed.
 *
 * @author Mario Schwede
 * @since 4.14.0
 */
@DoNotImplement
public interface MqttToKinesisInput extends TransformerInput {

    /**
     * @return The {@link PublishPacket} that triggered this transformer call.
     * @since 4.14.0
     */
    @NotNull PublishPacket getPublishPacket();
}