Package com.strongdm.api

Class RateLimitMetadata

java.lang.Object
com.strongdm.api.RateLimitMetadata
public class RateLimitMetadata extends Object
RateLimitMetadata contains information about remaining requests avaialable to the user over some timeframe.

  • Constructor Summary

    Constructors
    Constructor
    Description
    RateLimitMetadata()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getBucket()
    The bucket this user/token is associated with, which may be shared between multiple users/tokens.
    long
    getLimit()
    How many total requests the user/token is authorized to make before being rate limited.
    long
    getRemaining()
    How many remaining requests out of the limit are still avaialable.
    Date
    getResetAt()
    The time when remaining will be reset to limit.
    void
    setBucket(String in)
    The bucket this user/token is associated with, which may be shared between multiple users/tokens.
    void
    setLimit(long in)
    How many total requests the user/token is authorized to make before being rate limited.
    void
    setRemaining(long in)
    How many remaining requests out of the limit are still avaialable.
    void
    setResetAt(Date in)
    The time when remaining will be reset to limit.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • RateLimitMetadata

      public RateLimitMetadata()

  • Method Details

    • getBucket

      public String getBucket()
      The bucket this user/token is associated with, which may be shared between multiple users/tokens.

    • setBucket

      public void setBucket(String in)
      The bucket this user/token is associated with, which may be shared between multiple users/tokens.

    • getLimit

      public long getLimit()
      How many total requests the user/token is authorized to make before being rate limited.

    • setLimit

      public void setLimit(long in)
      How many total requests the user/token is authorized to make before being rate limited.

    • getRemaining

      public long getRemaining()
      How many remaining requests out of the limit are still avaialable.

    • setRemaining

      public void setRemaining(long in)
      How many remaining requests out of the limit are still avaialable.

    • getResetAt

      public Date getResetAt()
      The time when remaining will be reset to limit.

    • setResetAt

      public void setResetAt(Date in)
      The time when remaining will be reset to limit.