Package net.ygbstudio.jbrave.api.rate

Record Class XRateLimitRemaining

java.lang.Object
java.lang.Record
net.ygbstudio.jbrave.api.rate.XRateLimitRemaining
Record Components:
requestAvailable - Request available in the current second
monthlyRequestsRemaining - Requests remaining in the current month
public record XRateLimitRemaining(int requestAvailable, int monthlyRequestsRemaining) extends Record
Indicates how many requests you can still make within each time window before hitting the limit.

  • Constructor Details

    • XRateLimitRemaining

      public XRateLimitRemaining(int requestAvailable, int monthlyRequestsRemaining)
      Creates an instance of a XRateLimitRemaining record class.
      Parameters:
      requestAvailable - the value for the requestAvailable record component
      monthlyRequestsRemaining - the value for the monthlyRequestsRemaining record component

  • Method Details

    • from

      public static <T> Optional<XRateLimitRemaining> from(@NotNull @NotNull HttpResponse<T> httpResponse)
      Extracts the rate limit remaining from the HTTP Response.

      Check X-RateLimit-Remaining before making subsequent requests. This helps you avoid hitting limits unexpectedly.

      Type Parameters:
      T - the type of the response body
      Parameters:
      httpResponse - the HTTP Response object containing the rate limit remaining information
      Returns:
      an optional of the rate limit remaining extracted from the httpResponse

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with '=='.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • requestAvailable

      public int requestAvailable()
      Returns the value of the requestAvailable record component.
      Returns:
      the value of the requestAvailable record component

    • monthlyRequestsRemaining

      public int monthlyRequestsRemaining()
      Returns the value of the monthlyRequestsRemaining record component.
      Returns:
      the value of the monthlyRequestsRemaining record component