Package com.commercetools.api.models.subscription

Interface CloudEventsFormat

All Superinterfaces:
DeliveryFormat
All Known Subinterfaces:
DeliveryCloudEventsFormat
public interface CloudEventsFormat extends DeliveryFormat

The CloudEventsFormat can be used with any Destination, and the payload is delivered in the JSON Event Format. AzureEventGridDestination offers native support to filter and route CloudEvents.

Example to create an instance using the builder pattern 

     CloudEventsFormat cloudEventsFormat = CloudEventsFormat.builder()
             .cloudEventsVersion("{cloudEventsVersion}")
             .build()

  • Field Details

  • Method Details

    • getCloudEventsVersion

      @NotNull @NotNull String getCloudEventsVersion()
      Returns:
      cloudEventsVersion

    • setCloudEventsVersion

      void setCloudEventsVersion(String cloudEventsVersion)
      set cloudEventsVersion
      Parameters:
      cloudEventsVersion - value to be set

    • of

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

    • of

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

    • copyDeep

      CloudEventsFormat copyDeep()
      Specified by:
      copyDeep in interface DeliveryFormat

    • deepCopy

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

    • builder

      static CloudEventsFormatBuilder builder()
      builder factory method for CloudEventsFormat
      Returns:
      builder

    • builder

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

    • withCloudEventsFormat

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