Package com.commercetools.history.models.error

Interface TooManyRequestsError

All Superinterfaces:
ErrorObject
public interface TooManyRequestsError extends ErrorObject

Returned when the Query Records request exceeds the rate limit.

Reduce the date range and resource types in your query to minimize the token usage, or retry the request after some time (indicated in the Retry-After header).

Example to create an instance using the builder pattern 

     TooManyRequestsError tooManyRequestsError = TooManyRequestsError.builder()
             .code("{code}")
             .message("{message}")
             .build()

  • Field Details

    • TOO_MANY_REQUESTS

      static final String TOO_MANY_REQUESTS
      discriminator value for TooManyRequestsError
      See Also:

  • Method Details

    • getCode

      @NotNull @NotNull String getCode()

      "TooManyRequests"

      Specified by:
      getCode in interface ErrorObject
      Returns:
      code

    • getMessage

      @NotNull @NotNull String getMessage()

      "You have made too many requests. Please try again later."

      Specified by:
      getMessage in interface ErrorObject
      Returns:
      message

    • setCode

      void setCode(String code)

      "TooManyRequests"

      Specified by:
      setCode in interface ErrorObject
      Parameters:
      code - value to be set

    • setMessage

      void setMessage(String message)

      "You have made too many requests. Please try again later."

      Specified by:
      setMessage in interface ErrorObject
      Parameters:
      message - value to be set

    • of

      static TooManyRequestsError of()
      factory method
      Returns:
      instance of TooManyRequestsError

    • of

      static TooManyRequestsError of(TooManyRequestsError template)
      factory method to create a shallow copy TooManyRequestsError
      Parameters:
      template - instance to be copied
      Returns:
      copy instance

    • copyDeep

      TooManyRequestsError copyDeep()
      Specified by:
      copyDeep in interface ErrorObject

    • deepCopy

      @Nullable static TooManyRequestsError deepCopy(@Nullable TooManyRequestsError template)
      factory method to create a deep copy of TooManyRequestsError
      Parameters:
      template - instance to be copied
      Returns:
      copy instance

    • builder

      static TooManyRequestsErrorBuilder builder()
      builder factory method for TooManyRequestsError
      Returns:
      builder

    • builder

      static TooManyRequestsErrorBuilder builder(TooManyRequestsError template)
      create builder for TooManyRequestsError instance
      Parameters:
      template - instance with prefilled values for the builder
      Returns:
      builder

    • withTooManyRequestsError

      default <T> T withTooManyRequestsError(Function<TooManyRequestsError,T> helper)
      accessor map function
      Type Parameters:
      T - mapped type
      Parameters:
      helper - function to map the object
      Returns:
      mapped value

    • typeReference

      static com.fasterxml.jackson.core.type.TypeReference<TooManyRequestsError> typeReference()
      gives a TypeReference for usage with Jackson DataBind
      Returns:
      TypeReference