Package com.commercetools.api.models.error

Interface SearchNotReadyError

All Superinterfaces:
ErrorObject
public interface SearchNotReadyError extends ErrorObject

Returned if the requested search service is not ready. The search might be deactivated or indexing is in progress.

Example to create an instance using the builder pattern 

     SearchNotReadyError searchNotReadyError = SearchNotReadyError.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()

      $Search is not ready. Check the indexing-status endpoint and that the feature has been activated in the project settings.

      Specified by:
      getMessage in interface ErrorObject
      Returns:
      message

    • setMessage

      void setMessage(String message)

      $Search is not ready. Check the indexing-status endpoint and that the feature has been activated in the project settings.

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

    • of

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

    • of

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

    • deepCopy

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

    • builder

      static SearchNotReadyErrorBuilder builder()
      builder factory method for SearchNotReadyError
      Returns:
      builder

    • builder

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

    • withSearchNotReadyError

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