com.hivemq.extensions.google.cloud.pubsub.api.model.PubSubMessage Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of hivemq-google-cloud-pubsub-extension-customization-sdk Show documentation

SDK for the development of HiveMQ Google Cloud Pub/Sub Extension customizations

There is a newer version: 4.34.0

Show newest version

/*
 * Copyright 2022-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.google.cloud.pubsub.api.model;

import com.hivemq.extension.sdk.api.annotations.DoNotImplement;
import com.hivemq.extension.sdk.api.annotations.Immutable;
import com.hivemq.extension.sdk.api.annotations.NotNull;

import java.nio.ByteBuffer;
import java.util.Map;
import java.util.Optional;

/**
 * Represents a Google Cloud Pub/Sub message.
 * 
 * The internal state of this interface is immutable.
 * 

 * Every returned {@link ByteBuffer} is read only.
 * Every returned  {@code byte[]} is a defensive copy.
 * 
 *
 * @author Florian Limpöck
 * @author Mario Schwede
 * @since 4.9.0
 */
@Immutable
@DoNotImplement
public interface PubSubMessage {

    /**
     * @return A {@link Map} containing the attributes of this message. The {@link Map} might be empty.
     * @since 4.9.0
     */
    @Immutable @NotNull Map getAttributes();

    /**
     * @return An {@link Optional} of the data of this message.
     * @since 4.9.0
     */
    @NotNull Optional<@Immutable ByteBuffer> getData();

    /**
     * @return An {@link Optional} of the data of this message.
     * @since 4.9.0
     */
    @NotNull Optional getDataAsByteArray();

    /**
     * @return An {@link Optional} of the ordering key of this message.
     * @since 4.9.0
     */
    @NotNull Optional getOrderingKey();
}