io.quarkus.redis.datasource.stream.XPendingSummary Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of quarkus-redis-client Show documentation

Connect to Redis in either imperative or reactive style

There is a newer version: 3.17.5

package io.quarkus.redis.datasource.stream;

import java.util.Map;

/**
 * The result of the xpending command when using the summary form.
 * 
 * When using the summary form of xpending, the command outputs the total number of pending messages for this consumer
 * group, followed by the smallest and greatest ID among the pending messages, and then list every consumer in the
 * consumer group with at least one pending message, and the number of pending messages it has.
 */
public class XPendingSummary {

    private final long pendingCount;

    private final String lowestId;
    private final String highestId;

    private final Map consumers;

    public XPendingSummary(long pendingCount, String lowestId, String highestId, Map consumers) {
        this.pendingCount = pendingCount;
        this.lowestId = lowestId;
        this.highestId = highestId;
        this.consumers = consumers;
    }

    /**
     * Gets the number of message waiting for acknowledgement
     *
     * @return the number of message not yet acknowledged
     */
    public long getPendingCount() {
        return pendingCount;
    }

    /**
     * Gets the lowest message id that was not yet acknowledged.
     *
     * @return the lowest message id
     */
    public String getLowestId() {
        return lowestId;
    }

    /**
     * Gets the highest message id that was not yet acknowledged.
     *
     * @return the highest message id
     */
    public String getHighestId() {
        return highestId;
    }

    /**
     * Get the list of every consumer in the consumer group with at least one pending message,
     * and the number of pending messages it has.
     *
     * @return the map composed of consumer -> number of message
     */
    public Map getConsumers() {
        return consumers;
    }
}