Package com.commercetools.api.models.error

Interface QueryTimedOutError

All Superinterfaces:
ErrorObject
public interface QueryTimedOutError extends ErrorObject

Returned when the query times out.

If a query constantly times out, please check if it follows the performance best practices.

Example to create an instance using the builder pattern 

     QueryTimedOutError queryTimedOutError = QueryTimedOutError.builder()
             .message("{message}")
             .build()

  • Field Details

  • Method Details

    • getCode

      @NotNull @NotNull String getCode()
      Description copied from interface: ErrorObject

      Error identifier.

      Specified by:
      getCode in interface ErrorObject
      Returns:
      code

    • getMessage

      @NotNull @NotNull String getMessage()

      "The query timed out. If your query constantly times out, please check that it follows the performance best practices (see https://docs.commercetools.com/api/predicates/query#performance-considerations)."

      Specified by:
      getMessage in interface ErrorObject
      Returns:
      message

    • setMessage

      void setMessage(String message)

      "The query timed out. If your query constantly times out, please check that it follows the performance best practices (see https://docs.commercetools.com/api/predicates/query#performance-considerations)."

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

    • of

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

    • of

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

    • deepCopy

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

    • builder

      static QueryTimedOutErrorBuilder builder()
      builder factory method for QueryTimedOutError
      Returns:
      builder

    • builder

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

    • withQueryTimedOutError

      default <T> T withQueryTimedOutError(Function<QueryTimedOutError,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<QueryTimedOutError> typeReference()
      gives a TypeReference for usage with Jackson DataBind
      Returns:
      TypeReference