Package io.quarkus.smallrye.reactivemessaging.pulsar.deployment

Interface PulsarDevServicesBuildTimeConfig

public interface PulsarDevServicesBuildTimeConfig

  • Method Summary

    Modifier and Type
    Method
    Description
    Map<String,String>
    brokerConfig()
    Broker config to set on the Pulsar instance
    Optional<Boolean>
    enabled()
    If Dev Services for Pulsar has been explicitly enabled or disabled.
    Optional<String>
    imageName()
    The image to use.
    Optional<Integer>
    port()
    Optional fixed port the dev service will listen to.
    String
    serviceName()
    The value of the quarkus-dev-service-pulsar label attached to the started container.
    boolean
    shared()
    Indicates if the Pulsar broker managed by Quarkus Dev Services is shared.

  • Method Details

    • enabled

      Optional<Boolean> enabled()
      If Dev Services for Pulsar has been explicitly enabled or disabled. Dev Services are generally enabled by default, unless there is an existing configuration present. For Pulsar, Dev Services starts a broker unless pulsar.client.serviceUrl is set or if all the Reactive Messaging Pulsar channel are configured with serviceUrl.

    • port

      Optional<Integer> port()
      Optional fixed port the dev service will listen to.

      If not defined, the port will be chosen randomly.

    • imageName

      @ConfigDocDefault(value="`{pulsar-image}`", escape=false) Optional<String> imageName()
      The image to use. Note that only Apache Pulsar images are supported. Specifically, the image repository must end with apachepulsar/pulsar. Check https://hub.docker.com/r/apachepulsar/pulsar to find the available versions.

    • shared

      @WithDefault("true") boolean shared()
      Indicates if the Pulsar broker managed by Quarkus Dev Services is shared. When shared, Quarkus looks for running containers using label-based service discovery. If a matching container is found, it is used, and so a second one is not started. Otherwise, Dev Services for Pulsar starts a new container.

      The discovery uses the quarkus-dev-service-pulsar label. The value is configured using the service-name property.

      Container sharing is only used in dev mode.

    • serviceName

      @WithDefault("pulsar") String serviceName()
      The value of the quarkus-dev-service-pulsar label attached to the started container. This property is used when shared is set to true. In this case, before starting a container, Dev Services for Pulsar looks for a container with the quarkus-dev-service-pulsar label set to the configured value. If found, it will use this container instead of starting a new one. Otherwise, it starts a new container with the quarkus-dev-service-pulsar label set to the specified value.

      This property is used when you need multiple shared Pulsar brokers.

    • brokerConfig

      @ConfigDocMapKey("environment-variable-name") Map<String,String> brokerConfig()
      Broker config to set on the Pulsar instance