Package com.commercetools.api.models.warning

Interface WarningObject

All Known Subinterfaces:
ImageProcessingOngoingWarning
public interface WarningObject

Represents a warning related to the returned response.

Example to create a subtype instance using the builder pattern 

     WarningObject warningObject = WarningObject.imageProcessingOngoingBuilder()
             message("{message}")
             .build()

  • Method Details

    • getCode

      @NotNull @NotNull String getCode()

      Identifier for the type of warning.

      Returns:
      code

    • getMessage

      @NotNull @NotNull String getMessage()

      Contains information about the returned response.

      Returns:
      message

    • setMessage

      void setMessage(String message)

      Contains information about the returned response.

      Parameters:
      message - value to be set

    • deepCopy

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

    • imageProcessingOngoingBuilder

      static ImageProcessingOngoingWarningBuilder imageProcessingOngoingBuilder()
      builder for imageProcessingOngoing subtype
      Returns:
      builder

    • withWarningObject

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