Package com.commercetools.api.models.agent

Interface AgentProductsNotFoundWarning

All Superinterfaces:
WarningObject
public interface AgentProductsNotFoundWarning extends WarningObject

Returned when one or more Products referenced in an Intake Agent API request could not be matched to the catalog. The unmatched Products are omitted from the created entity.

Example to create an instance using the builder pattern 

     AgentProductsNotFoundWarning agentProductsNotFoundWarning = AgentProductsNotFoundWarning.builder()
             .message("{message}")
             .plusProducts(productsBuilder -> productsBuilder)
             .build()

  • Field Details

    • PRODUCTS_NOT_FOUND

      static final String PRODUCTS_NOT_FOUND
      discriminator value for AgentProductsNotFoundWarning
      See Also:

  • Method Details

    • getCode

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

      Identifier for the type of warning.

      Specified by:
      getCode in interface WarningObject
      Returns:
      code

    • getMessage

      @NotNull @NotNull String getMessage()

      Plain text description of the unmatched Products.

      Specified by:
      getMessage in interface WarningObject
      Returns:
      message

    • getProducts

      @NotNull @NotNull List<String> getProducts()

      Identifiers of the Products that could not be matched to the catalog, as they appeared in the input.

      Returns:
      products

    • setMessage

      void setMessage(String message)

      Plain text description of the unmatched Products.

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

    • setProducts

      void setProducts(String... products)

      Identifiers of the Products that could not be matched to the catalog, as they appeared in the input.

      Parameters:
      products - values to be set

    • setProducts

      void setProducts(List<String> products)

      Identifiers of the Products that could not be matched to the catalog, as they appeared in the input.

      Parameters:
      products - values to be set

    • of

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

    • of

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

    • copyDeep

      AgentProductsNotFoundWarning copyDeep()
      Specified by:
      copyDeep in interface WarningObject

    • deepCopy

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

    • builder

      static AgentProductsNotFoundWarningBuilder builder()
      builder factory method for AgentProductsNotFoundWarning
      Returns:
      builder

    • builder

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

    • withAgentProductsNotFoundWarning

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

    • typeReference

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