Package com.commercetools.api.models.subscription

Interface ConfluentCloudDestination

All Superinterfaces:
Destination
public interface ConfluentCloudDestination extends Destination

This destination can be used to push notifications to Confluent Cloud. To set up a Subscription of this type, first, create a topic in Confluent Cloud. Then, to allow Composable Commerce to push notifications to your topic, generate API keys for your topic, and create the Subscription destination using the generated credentials.

The Composable Commerce producer uses the following values: SASL_SSL forsecurity.protocol, PLAIN forsasl.mechanism, and the default value (1048576) for max.request.size.

Example to create an instance using the builder pattern 

     ConfluentCloudDestination confluentCloudDestination = ConfluentCloudDestination.builder()
             .bootstrapServer("{bootstrapServer}")
             .apiKey("{apiKey}")
             .apiSecret("{apiSecret}")
             .acks("{acks}")
             .topic("{topic}")
             .build()

  • Field Details

    • CONFLUENT_CLOUD

      static final String CONFLUENT_CLOUD
      discriminator value for ConfluentCloudDestination
      See Also:

  • Method Details

    • getBootstrapServer

      @NotNull @NotNull String getBootstrapServer()

      URL to the bootstrap server including the port number in the format <xxxxx>.<region>.<provider>.confluent.cloud:9092.

      Returns:
      bootstrapServer

    • getApiKey

      @NotNull @NotNull String getApiKey()

      Partially hidden on retrieval for security reasons.

      Returns:
      apiKey

    • getApiSecret

      @NotNull @NotNull String getApiSecret()

      Partially hidden on retrieval for security reasons.

      Returns:
      apiSecret

    • getAcks

      @NotNull @NotNull String getAcks()

      The Kafka acks value.

      Returns:
      acks

    • getTopic

      @NotNull @NotNull String getTopic()

      The name of the topic.

      Returns:
      topic

    • getKey

      String getKey()

      The Kafka record key.

      Returns:
      key

    • setBootstrapServer

      void setBootstrapServer(String bootstrapServer)

      URL to the bootstrap server including the port number in the format <xxxxx>.<region>.<provider>.confluent.cloud:9092.

      Parameters:
      bootstrapServer - value to be set

    • setApiKey

      void setApiKey(String apiKey)

      Partially hidden on retrieval for security reasons.

      Parameters:
      apiKey - value to be set

    • setApiSecret

      void setApiSecret(String apiSecret)

      Partially hidden on retrieval for security reasons.

      Parameters:
      apiSecret - value to be set

    • setAcks

      void setAcks(String acks)

      The Kafka acks value.

      Parameters:
      acks - value to be set

    • setTopic

      void setTopic(String topic)

      The name of the topic.

      Parameters:
      topic - value to be set

    • setKey

      void setKey(String key)

      The Kafka record key.

      Parameters:
      key - value to be set

    • of

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

    • of

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

    • copyDeep

      ConfluentCloudDestination copyDeep()
      Specified by:
      copyDeep in interface Destination

    • deepCopy

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

    • builder

      static ConfluentCloudDestinationBuilder builder()
      builder factory method for ConfluentCloudDestination
      Returns:
      builder

    • builder

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

    • withConfluentCloudDestination

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