Package com.commercetools.api.models.subscription

Interface ResourceDeletedDeliveryPayload

All Superinterfaces:
DeliveryPayload, SubscriptionNotification
All Known Subinterfaces:
ResourceDeletedDelivery
public interface ResourceDeletedDeliveryPayload extends DeliveryPayload

This payload is sent for a ChangeSubscription when a resource is deleted.

Example to create an instance using the builder pattern 

     ResourceDeletedDeliveryPayload resourceDeletedDeliveryPayload = ResourceDeletedDeliveryPayload.builder()
             .projectKey("{projectKey}")
             .resource(resourceBuilder -> resourceBuilder)
             .version(0.3)
             .modifiedAt(ZonedDateTime.parse("2022-01-01T12:00:00.301Z"))
             .build()

  • Field Details

    • RESOURCE_DELETED

      static final String RESOURCE_DELETED
      discriminator value for ResourceDeletedDeliveryPayload
      See Also:

  • Method Details

    • getVersion

      @NotNull @NotNull Long getVersion()

      Last seen version of the resource.

      Returns:
      version

    • getModifiedAt

      @NotNull @NotNull ZonedDateTime getModifiedAt()

      Date and time (UTC) the resource was last deleted.

      Returns:
      modifiedAt

    • getDataErasure

      Boolean getDataErasure()

      true if the dataErasure parameter on the DELETE request was set to true.

      Returns:
      dataErasure

    • setVersion

      void setVersion(Long version)

      Last seen version of the resource.

      Parameters:
      version - value to be set

    • setModifiedAt

      void setModifiedAt(ZonedDateTime modifiedAt)

      Date and time (UTC) the resource was last deleted.

      Parameters:
      modifiedAt - value to be set

    • setDataErasure

      void setDataErasure(Boolean dataErasure)

      true if the dataErasure parameter on the DELETE request was set to true.

      Parameters:
      dataErasure - value to be set

    • of

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

    • of

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

    • copyDeep

      ResourceDeletedDeliveryPayload copyDeep()
      Specified by:
      copyDeep in interface DeliveryPayload
      Specified by:
      copyDeep in interface SubscriptionNotification

    • deepCopy

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

    • builder

      static ResourceDeletedDeliveryPayloadBuilder builder()
      builder factory method for ResourceDeletedDeliveryPayload
      Returns:
      builder

    • builder

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

    • withResourceDeletedDeliveryPayload

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