redis.clients.jedis.params.HGetExParams Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jedis Show documentation

Jedis is a blazingly small and sane Redis java client.

There is a newer version: 6.0.0-beta2

package redis.clients.jedis.params;

/**
 * HGetExParams is a parameter class used when getting values of given keys in hash data with 
 * optionally setting/changing expiry time in Redis.
 * It can be used to set the expiry time of the key in seconds or milliseconds.
 * 
 * This class includes the following methods:
 * 
 *   {@link #hGetExParams()} - Static factory method to create a new instance of HGetExParams.
 *   {@link #ex(long)} - Set the specified expire time, in seconds.
 *   {@link #px(long)} - Set the specified expire time, in milliseconds.
 *   {@link #exAt(long)} - Set the specified Unix(epoch) time at which the key will expire, in seconds.
 *   {@link #pxAt(long)} - Set the specified Unix(epoch) time at which the key will expire, in milliseconds.
 *   {@link #persist()} - Remove the time-to-live associated with the key.
 * 
 * 
 * Example usage:
 *  * {@code
 * HGetExParams params = HGetExParams.hGetExParams().persist();
 * }
 * 
 * 
 * @see BaseGetExParams
 */
public class HGetExParams extends BaseGetExParams {

  public static HGetExParams hGetExParams() {
    return new HGetExParams();
  }
}