Package com.commercetools.api.models.subscription

Interface SubscriptionNotification

All Known Subinterfaces:
DeliveryPayload, EventDeliveryPayload, MessageDelivery, MessageDeliveryPayload, ResourceCreatedDelivery, ResourceCreatedDeliveryPayload, ResourceDeletedDelivery, ResourceDeletedDeliveryPayload, ResourceUpdatedDelivery, ResourceUpdatedDeliveryPayload, SubscriptionDelivery
public interface SubscriptionNotification

All payloads for the PlatformFormat share these common fields.

Example to create a subtype instance using the builder pattern 

     SubscriptionNotification subscriptionNotification = SubscriptionNotification.eventBuilder()
             id("{id}")
             type(EventType.CHECKOUT_ORDER_CREATION_FAILED)
             resourceType("{resourceType}")
             data(dataBuilder -> dataBuilder)
             createdAt(ZonedDateTime.parse("2022-01-01T12:00:00.301Z"))
             .build()

  • Method Details

    • getNotificationType

      @NotNull @NotNull String getNotificationType()

      Identifies the payload.

      Returns:
      notificationType

    • copyDeep

      SubscriptionNotification copyDeep()

    • deepCopy

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

    • eventBuilder

      static EventDeliveryPayloadBuilder eventBuilder()
      builder for event subtype
      Returns:
      builder

    • messageBuilder

      static MessageDeliveryPayloadBuilder messageBuilder()
      builder for message subtype
      Returns:
      builder

    • resourceCreatedBuilder

      static ResourceCreatedDeliveryPayloadBuilder resourceCreatedBuilder()
      builder for resourceCreated subtype
      Returns:
      builder

    • resourceDeletedBuilder

      static ResourceDeletedDeliveryPayloadBuilder resourceDeletedBuilder()
      builder for resourceDeleted subtype
      Returns:
      builder

    • resourceUpdatedBuilder

      static ResourceUpdatedDeliveryPayloadBuilder resourceUpdatedBuilder()
      builder for resourceUpdated subtype
      Returns:
      builder

    • withSubscriptionNotification

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