Package com.commercetools.api.models.subscription

Interface AzureServiceBusDestination

All Superinterfaces:
Destination
public interface AzureServiceBusDestination extends Destination

Azure Service Bus can be used as a pull-queue with Queues, or to fan-out notifications with Topics and Subscriptions. To set up a Subscription with Azure Service Bus, first create a queue/topic in the Azure Portal with a Shared Access Policy including the Send permission.

Example to create an instance using the builder pattern 

     AzureServiceBusDestination azureServiceBusDestination = AzureServiceBusDestination.builder()
             .connectionString("{connectionString}")
             .build()

  • Field Details

    • AZURE_SERVICE_BUS

      static final String AZURE_SERVICE_BUS
      discriminator value for AzureServiceBusDestination
      See Also:

  • Method Details

    • getConnectionString

      @NotNull @NotNull String getConnectionString()

      SharedAccessKey is partially hidden on retrieval for security reasons.

      Returns:
      connectionString

    • setConnectionString

      void setConnectionString(String connectionString)

      SharedAccessKey is partially hidden on retrieval for security reasons.

      Parameters:
      connectionString - value to be set

    • of

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

    • of

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

    • deepCopy

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

    • builder

      static AzureServiceBusDestinationBuilder builder()
      builder factory method for AzureServiceBusDestination
      Returns:
      builder

    • builder

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

    • withAzureServiceBusDestination

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