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 Summary
Modifier and TypeMethodDescriptioncopyDeep()
static SubscriptionNotification
deepCopy
(SubscriptionNotification template) factory method to create a deep copy of SubscriptionNotificationstatic EventDeliveryPayloadBuilder
builder for event subtype@NotNull String
Identifies the payload.builder for message subtypebuilder for resourceCreated subtypebuilder for resourceDeleted subtypebuilder for resourceUpdated subtypestatic com.fasterxml.jackson.core.type.TypeReference<SubscriptionNotification>
gives a TypeReference for usage with Jackson DataBinddefault <T> T
accessor map function
-
Method Details
-
getNotificationType
Identifies the payload.
- Returns:
- notificationType
-
copyDeep
SubscriptionNotification copyDeep() -
deepCopy
factory method to create a deep copy of SubscriptionNotification- Parameters:
template
- instance to be copied- Returns:
- copy instance
-
eventBuilder
builder for event subtype- Returns:
- builder
-
messageBuilder
builder for message subtype- Returns:
- builder
-
resourceCreatedBuilder
builder for resourceCreated subtype- Returns:
- builder
-
resourceDeletedBuilder
builder for resourceDeleted subtype- Returns:
- builder
-
resourceUpdatedBuilder
builder for resourceUpdated subtype- Returns:
- builder
-
withSubscriptionNotification
accessor map function- Type Parameters:
T
- mapped type- Parameters:
helper
- function to map the object- Returns:
- mapped value
-
typeReference
gives a TypeReference for usage with Jackson DataBind- Returns:
- TypeReference
-