Package com.commercetools.api.models.agent

Interface AgentFileNotProcessedWarning

All Superinterfaces:
WarningObject
public interface AgentFileNotProcessedWarning extends WarningObject

Returned when an uploaded file in an Intake Agent API request could not be parsed.

Example to create an instance using the builder pattern 

     AgentFileNotProcessedWarning agentFileNotProcessedWarning = AgentFileNotProcessedWarning.builder()
             .message("{message}")
             .fileName("{fileName}")
             .build()

  • Field Details

    • FILE_NOT_PROCESSED

      static final String FILE_NOT_PROCESSED
      discriminator value for AgentFileNotProcessedWarning
      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 why the file could not be parsed.

      Specified by:
      getMessage in interface WarningObject
      Returns:
      message

    • getFileName

      @NotNull @NotNull String getFileName()

      Name of the file that failed to parse.

      Returns:
      fileName

    • setMessage

      void setMessage(String message)

      Plain text description of why the file could not be parsed.

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

    • setFileName

      void setFileName(String fileName)

      Name of the file that failed to parse.

      Parameters:
      fileName - value to be set

    • of

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

    • of

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

    • copyDeep

      AgentFileNotProcessedWarning copyDeep()
      Specified by:
      copyDeep in interface WarningObject

    • deepCopy

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

    • builder

      static AgentFileNotProcessedWarningBuilder builder()
      builder factory method for AgentFileNotProcessedWarning
      Returns:
      builder

    • builder

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

    • withAgentFileNotProcessedWarning

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