Package net.ygbstudio.jbrave.api.rate

Record Class XRateLimit

java.lang.Object
java.lang.Record
net.ygbstudio.jbrave.api.rate.XRateLimit
Record Components:
requestsPerSecond - Burst rate limit
requestsPerMonth - Monthly quota (0 for unlimited)
public record XRateLimit(int requestsPerSecond, int requestsPerMonth) extends Record
Shows the maximum number of requests allowed for each time window in your plan.

  • Constructor Details

    • XRateLimit

      public XRateLimit(int requestsPerSecond, int requestsPerMonth)
      Creates an instance of a XRateLimit record class.
      Parameters:
      requestsPerSecond - the value for the requestsPerSecond record component
      requestsPerMonth - the value for the requestsPerMonth record component

  • Method Details

    • from

      public static <T> Optional<XRateLimit> from(@NotNull @NotNull HttpResponse<T> httpResponse)
      Extracts the rate limit from the HTTP Response.
      Type Parameters:
      T - the type of the response body
      Parameters:
      httpResponse - the HTTP httpResponse containing the rate limit information
      Returns:
      an optional of the rate limit 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.

    • requestsPerSecond

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

    • requestsPerMonth

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