Package com.commercetools.importapi.models.importsummaries

Interface ImportSummary

public interface ImportSummary

The current status of ImportOperations in an ImportContainer.

Example to create an instance using the builder pattern 

     ImportSummary importSummary = ImportSummary.builder()
             .states(statesBuilder -> statesBuilder)
             .total(1)
             .build()

  • Method Details

    • getStates

      @NotNull @Valid @NotNull @Valid OperationStates getStates()

      The current ProcessingStates of ImportOperations in an ImportContainer.

      Returns:
      states

    • getTotal

      @NotNull @NotNull Long getTotal()

      The total number of ImportOperations in states.

      Returns:
      total

    • setStates

      void setStates(OperationStates states)

      The current ProcessingStates of ImportOperations in an ImportContainer.

      Parameters:
      states - value to be set

    • setTotal

      void setTotal(Long total)

      The total number of ImportOperations in states.

      Parameters:
      total - value to be set

    • of

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

    • of

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

    • copyDeep

      ImportSummary copyDeep()

    • deepCopy

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

    • builder

      static ImportSummaryBuilder builder()
      builder factory method for ImportSummary
      Returns:
      builder

    • builder

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

    • withImportSummary

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