Package com.commercetools.api.models.subscription

Interface ChangeSubscription

public interface ChangeSubscription

Notification about changes to a resource. The payload format differs for resource creation, update, and deletion.

Example to create an instance using the builder pattern 

     ChangeSubscription changeSubscription = ChangeSubscription.builder()
             .resourceTypeId(ChangeSubscriptionResourceTypeId.APPROVAL_FLOW)
             .build()

  • Method Details

    • getResourceTypeId

      @NotNull @NotNull ChangeSubscriptionResourceTypeId getResourceTypeId()

      Unique identifier for the type of resource, for example, order.

      Returns:
      resourceTypeId

    • setResourceTypeId

      void setResourceTypeId(ChangeSubscriptionResourceTypeId resourceTypeId)

      Unique identifier for the type of resource, for example, order.

      Parameters:
      resourceTypeId - value to be set

    • of

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

    • of

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

    • copyDeep

      ChangeSubscription copyDeep()

    • deepCopy

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

    • builder

      static ChangeSubscriptionBuilder builder()
      builder factory method for ChangeSubscription
      Returns:
      builder

    • builder

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

    • withChangeSubscription

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