com.microsoft.azure.eventhubs.EventDataBatch Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of azure-eventhubs Show documentation

Please note, a newer package azure-messaging-eventhubs for Azure Event Hubs is available at https://search.maven.org/artifact/com.azure/azure-messaging-eventhubs as of February 2020. While this package will continue to receive critical bug fixes, we strongly encourage you to upgrade. Read the migration guide at https://aka.ms/azsdk/java/migrate/eh for more details.

The newest version!

// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.

package com.microsoft.azure.eventhubs;

/**
 * Helper for creating a batch/collection of EventData objects to be used while Sending to EventHubs
 */
public interface EventDataBatch {

    /**
     * Get the number of events present in this {@link EventDataBatch}
     *
     * @return the EventDataBatch size
     */
    int getSize();

    /**
     * Add's {@link EventData} to {@link EventDataBatch}, if permitted by the batch's size limit.
     * This method is not thread-safe.
     *
     * @param eventData The {@link EventData} to add.
     * @return A boolean value indicating if the {@link EventData} addition to this batch/collection was successful or not.
     * @throws PayloadSizeExceededException when a single {@link EventData} instance exceeds maximum allowed size of the batch
     */
    boolean tryAdd(EventData eventData) throws PayloadSizeExceededException;
}