Package com.commercetools.history.models.change

Interface UnpublishChange

All Superinterfaces:
Change
public interface UnpublishChange extends Change

Change triggered when ProductCatalogData published transitions from true to false.

For better traceability of the Unpublish update action, use the ProductUnpublished Message.

Example to create an instance using the builder pattern 

     UnpublishChange unpublishChange = UnpublishChange.builder()
             .change("{change}")
             .build()

  • Field Details

  • Method Details

    • getType

      @NotNull @NotNull String getType()
      Description copied from interface: Change

      Unique discriminator value to reliably deserialize the data type.

      Specified by:
      getType in interface Change
      Returns:
      type

    • getChange

      @NotNull @NotNull String getChange()
      Description copied from interface: Change

      Type of change on a resource that is similar to the update action it relates to, where possible. It is not a unique identifier for the data structure, for example, the setDescription change can occur with a localized and non-localized representation.

      Records can be filtered by this value using the changes query parameter.

      Specified by:
      getChange in interface Change
      Returns:
      change

    • setChange

      void setChange(String change)
      set change
      Specified by:
      setChange in interface Change
      Parameters:
      change - value to be set

    • of

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

    • of

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

    • copyDeep

      UnpublishChange copyDeep()
      Specified by:
      copyDeep in interface Change

    • deepCopy

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

    • builder

      static UnpublishChangeBuilder builder()
      builder factory method for UnpublishChange
      Returns:
      builder

    • builder

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

    • withUnpublishChange

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