redis.clients.jedis.StreamConsumersInfo Maven / Gradle / Ivy

package redis.clients.jedis;

import java.util.Map;

/**
 * This class holds information about a consumer. They can be access via getters. For future purpose
 * there is also {@link #getConsumerInfo()}} method that returns a generic {@code Map} - in case
 * where more info is returned from the server.
 */
public class StreamConsumersInfo {

  public static final String NAME = "name";
  public static final String IDLE = "idle";
  public static final String PENDING = "pending";

  private final String name;
  private final long idle;
  private final long pending;
  private final Map consumerInfo;

  /**
   * @param map contains key-value pairs with consumer info
   */
  public StreamConsumersInfo(Map map) {

    consumerInfo = map;
    name = (String) map.get(NAME);
    idle = (long) map.get(IDLE);
    pending = (long) map.get(PENDING);

  }

  public String getName() {
    return name;
  }

  public long getIdle() {
    return idle;
  }

  public long getPending() {
    return pending;
  }

  /**
   * @return Generic map containing all key-value pairs returned by the server
   */
  public Map getConsumerInfo() {
    return consumerInfo;
  }

}