diff --git a/deployment/src/main/java/io/quarkiverse/zeebe/ZeebeDevProcessor.java b/deployment/src/main/java/io/quarkiverse/zeebe/ZeebeDevProcessor.java index b504cf8..a50dca0 100644 --- a/deployment/src/main/java/io/quarkiverse/zeebe/ZeebeDevProcessor.java +++ b/deployment/src/main/java/io/quarkiverse/zeebe/ZeebeDevProcessor.java @@ -22,7 +22,7 @@ public class ZeebeDevProcessor { @BuildStep(onlyIf = IsDevelopment.class) void hotReload(ZeebeDevServiceBuildTimeConfig buildTimeConfig, BuildProducer additionalBeans) { - if (buildTimeConfig.devMode.watchJobWorker) { + if (buildTimeConfig.devMode().watchJobWorker()) { additionalBeans.produce(AdditionalBeanBuildItem.unremovableOf(JobWorkerReplacementInterceptor.class)); } } @@ -32,12 +32,12 @@ void watchChanges(ZeebeBuildTimeConfig config, ZeebeResourcesBuildItem resources ZeebeDevServiceBuildTimeConfig buildTimeConfig, BuildProducer watchedPaths) { - if (!config.resources.enabled) { + if (!config.resources().enabled()) { return; } // add all bpmn resources - if (buildTimeConfig.devMode.watchBpmnFiles) { + if (buildTimeConfig.devMode().watchBpmnFiles()) { Collection items = resources.getResources(); if (items != null && !items.isEmpty()) { items.forEach(x -> watchedPaths.produce(new HotDeploymentWatchedFileBuildItem(x))); @@ -46,12 +46,12 @@ void watchChanges(ZeebeBuildTimeConfig config, ZeebeResourcesBuildItem resources // watch directories for new files // add root directory and all subdirectories - if (buildTimeConfig.devMode.watchBpmnDir) { - watchedPaths.produce(new HotDeploymentWatchedFileBuildItem(config.resources.location)); + if (buildTimeConfig.devMode().watchBpmnDir()) { + watchedPaths.produce(new HotDeploymentWatchedFileBuildItem(config.resources().location())); try { Enumeration location = Thread.currentThread().getContextClassLoader() - .getResources(config.resources.location); + .getResources(config.resources().location()); if (location.hasMoreElements()) { Files.walk(Path.of(location.nextElement().toURI())) .filter(Files::isDirectory) @@ -61,7 +61,7 @@ void watchChanges(ZeebeBuildTimeConfig config, ZeebeResourcesBuildItem resources .forEach(dir -> watchedPaths.produce(new HotDeploymentWatchedFileBuildItem(dir))); } } catch (Exception ex) { - throw new RuntimeException("Error find all sub-directories of " + config.resources.location, ex); + throw new RuntimeException("Error find all sub-directories of " + config.resources().location(), ex); } } } diff --git a/deployment/src/main/java/io/quarkiverse/zeebe/ZeebeDevServiceBuildTimeConfig.java b/deployment/src/main/java/io/quarkiverse/zeebe/ZeebeDevServiceBuildTimeConfig.java index cc33ee1..07dd2b2 100644 --- a/deployment/src/main/java/io/quarkiverse/zeebe/ZeebeDevServiceBuildTimeConfig.java +++ b/deployment/src/main/java/io/quarkiverse/zeebe/ZeebeDevServiceBuildTimeConfig.java @@ -1,48 +1,56 @@ package io.quarkiverse.zeebe; import io.quarkiverse.zeebe.devservices.ZeebeDevServicesConfig; -import io.quarkus.runtime.annotations.ConfigGroup; -import io.quarkus.runtime.annotations.ConfigItem; import io.quarkus.runtime.annotations.ConfigPhase; import io.quarkus.runtime.annotations.ConfigRoot; +import io.smallrye.config.ConfigMapping; +import io.smallrye.config.WithDefault; +import io.smallrye.config.WithName; -@ConfigRoot(name = "zeebe", phase = ConfigPhase.BUILD_TIME) -public class ZeebeDevServiceBuildTimeConfig { +@ConfigRoot(phase = ConfigPhase.BUILD_TIME) +@ConfigMapping(prefix = "quarkus.zeebe") +public interface ZeebeDevServiceBuildTimeConfig { /** * Default Dev services configuration. */ - @ConfigItem(name = "devservices") - public ZeebeDevServicesConfig devService; + @WithName("devservices") + ZeebeDevServicesConfig devService(); /** * Dev mode configuration. */ - @ConfigItem(name = "dev-mode") - public DevMode devMode; + @WithName("dev-mode") + DevMode devMode(); - @ConfigGroup - public static class DevMode { + interface DevMode { /** * Disable or enabled zeebe dashboard dev-ui. */ - @ConfigItem(name = "dev-ui.enabled", defaultValue = "true") - public boolean devUIEnabled; + @WithName("dev-ui.enabled") + @WithDefault("true") + boolean devUIEnabled(); + /** * Observe changes in the bpmn files. */ - @ConfigItem(name = "watch-bpmn-files", defaultValue = "true") - public boolean watchBpmnFiles = true; + @WithName("watch-bpmn-files") + @WithDefault("true") + boolean watchBpmnFiles(); + /** * Observe changes in the bpmn directory and subdirectories. */ - @ConfigItem(name = "watch-bpmn-dir", defaultValue = "true") - public boolean watchBpmnDir = true; + @WithName("watch-bpmn-dir") + @WithDefault("true") + boolean watchBpmnDir(); + /** * Observe changes in the job worker. */ - @ConfigItem(name = "watch-job-worker", defaultValue = "true") - public boolean watchJobWorker = true; + @WithName("watch-job-worker") + @WithDefault("true") + boolean watchJobWorker(); } } diff --git a/deployment/src/main/java/io/quarkiverse/zeebe/ZeebeProcessor.java b/deployment/src/main/java/io/quarkiverse/zeebe/ZeebeProcessor.java index 95fa006..7d1e58a 100644 --- a/deployment/src/main/java/io/quarkiverse/zeebe/ZeebeProcessor.java +++ b/deployment/src/main/java/io/quarkiverse/zeebe/ZeebeProcessor.java @@ -79,7 +79,7 @@ static class TracingEnabled implements BooleanSupplier { @Override public boolean getAsBoolean() { - return config.tracing.enabled; + return config.tracing().enabled(); } } @@ -99,7 +99,7 @@ static class MetricsEnabled implements BooleanSupplier { @Override public boolean getAsBoolean() { - return config.metrics.enabled; + return config.metrics().enabled(); } } @@ -294,7 +294,7 @@ void buildZeebeResources( .fields(true) .build()); - Collection resources = discoverResources(config.resources); + Collection resources = discoverResources(config.resources()); if (!resources.isEmpty()) { resource.produce(new NativeImageResourceBuildItem(resources.toArray(new String[0]))); } @@ -305,8 +305,8 @@ void buildZeebeResources( @BuildStep void addHealthCheck(ZeebeBuildTimeConfig config, BuildProducer healthChecks) { - healthChecks.produce(new HealthBuildItem(ZeebeHealthCheck.class.getName(), config.health.enabled)); - healthChecks.produce(new HealthBuildItem(ZeebeTopologyHealthCheck.class.getName(), config.health.enabled)); + healthChecks.produce(new HealthBuildItem(ZeebeHealthCheck.class.getName(), config.health().enabled())); + healthChecks.produce(new HealthBuildItem(ZeebeTopologyHealthCheck.class.getName(), config.health().enabled())); } @BuildStep @@ -353,10 +353,10 @@ NativeImageConfigBuildItem build() { private Collection discoverResources(ZeebeBuildTimeConfig.ResourcesConfig resourcesConfig) throws IOException, URISyntaxException { - if (!resourcesConfig.enabled) { + if (!resourcesConfig.enabled()) { return Collections.emptySet(); } - String location = resourcesConfig.location; + String location = resourcesConfig.location(); LinkedHashSet result = new LinkedHashSet<>(); location = normalizeLocation(location); diff --git a/deployment/src/main/java/io/quarkiverse/zeebe/ZeebeResourcesBuildItem.java b/deployment/src/main/java/io/quarkiverse/zeebe/ZeebeResourcesBuildItem.java index aa3f651..9061d6c 100644 --- a/deployment/src/main/java/io/quarkiverse/zeebe/ZeebeResourcesBuildItem.java +++ b/deployment/src/main/java/io/quarkiverse/zeebe/ZeebeResourcesBuildItem.java @@ -8,10 +8,6 @@ public final class ZeebeResourcesBuildItem extends SimpleBuildItem { final Collection resources; - public ZeebeResourcesBuildItem() { - this.resources = null; - } - public ZeebeResourcesBuildItem(Collection resources) { this.resources = resources; } diff --git a/deployment/src/main/java/io/quarkiverse/zeebe/ZeebeWorkersBuildItem.java b/deployment/src/main/java/io/quarkiverse/zeebe/ZeebeWorkersBuildItem.java index 707b69e..76a0f8e 100644 --- a/deployment/src/main/java/io/quarkiverse/zeebe/ZeebeWorkersBuildItem.java +++ b/deployment/src/main/java/io/quarkiverse/zeebe/ZeebeWorkersBuildItem.java @@ -9,10 +9,6 @@ public final class ZeebeWorkersBuildItem extends SimpleBuildItem { final List workers; - public ZeebeWorkersBuildItem() { - this.workers = null; - } - public ZeebeWorkersBuildItem(List workers) { this.workers = workers; } diff --git a/deployment/src/main/java/io/quarkiverse/zeebe/devservices/DevUIZeebeProcessor.java b/deployment/src/main/java/io/quarkiverse/zeebe/devservices/DevUIZeebeProcessor.java index 98b26b4..8bd5ca7 100644 --- a/deployment/src/main/java/io/quarkiverse/zeebe/devservices/DevUIZeebeProcessor.java +++ b/deployment/src/main/java/io/quarkiverse/zeebe/devservices/DevUIZeebeProcessor.java @@ -33,7 +33,7 @@ public void pages(ZeebeDevServiceBuildTimeConfig buildTimeConfig, BuildProducer menuProducer, BuildProducer rpcProvidersBuildItemBuildProducer) { - if (!buildTimeConfig.devMode.devUIEnabled || !buildTimeConfig.devService.enabled) { + if (!buildTimeConfig.devMode().devUIEnabled() || !buildTimeConfig.devService().enabled()) { log.debug( "Not starting dev-ui for Zeebe as it has been disabled in the config or dev-service has been not enabled"); return; diff --git a/deployment/src/main/java/io/quarkiverse/zeebe/devservices/ZeebeDevServiceProcessor.java b/deployment/src/main/java/io/quarkiverse/zeebe/devservices/ZeebeDevServiceProcessor.java index db88ccf..ffc6ff6 100644 --- a/deployment/src/main/java/io/quarkiverse/zeebe/devservices/ZeebeDevServiceProcessor.java +++ b/deployment/src/main/java/io/quarkiverse/zeebe/devservices/ZeebeDevServiceProcessor.java @@ -41,7 +41,7 @@ public class ZeebeDevServiceProcessor { private static final String DEFAULT_ZEEBE_VERSION = ZeebeClient.class.getPackage().getImplementationVersion(); - private static DockerImageName ZEEBE_IMAGE_NAME = DockerImageName.parse(DEFAULT_ZEEBE_CONTAINER_IMAGE) + private static final DockerImageName ZEEBE_IMAGE_NAME = DockerImageName.parse(DEFAULT_ZEEBE_CONTAINER_IMAGE) .withTag(DEFAULT_ZEEBE_VERSION); private static final Logger log = Logger.getLogger(ZeebeDevServiceProcessor.class); @@ -144,7 +144,7 @@ private ZeebeRunningDevService startZeebe(DockerStatusBuildItem dockerStatusBuil return null; } - if (!dockerStatusBuildItem.isDockerAvailable()) { + if (!dockerStatusBuildItem.isContainerRuntimeAvailable()) { log.warn( "Docker isn't working, please configure the zeebe broker servers gateway property (" + PROP_ZEEBE_GATEWAY_ADDRESS + ")."); @@ -247,7 +247,7 @@ private void stopZeebe() { } private ZeebeDevServiceCfg getConfiguration(ZeebeDevServiceBuildTimeConfig cfg) { - ZeebeDevServicesConfig devServicesConfig = cfg.devService; + ZeebeDevServicesConfig devServicesConfig = cfg.devService(); return new ZeebeDevServiceCfg(devServicesConfig); } @@ -269,17 +269,17 @@ private static final class ZeebeDevServiceCfg { private final boolean reuse; public ZeebeDevServiceCfg(ZeebeDevServicesConfig config) { - this.devServicesEnabled = config.enabled; - this.imageName = config.imageName.orElse(null); - this.fixedExposedPort = config.port.orElse(0); - this.fixedExposedRestPort = config.restPort.orElse(0); - this.shared = config.shared; - this.serviceName = config.serviceName; - this.testExporter = config.test.exporter; - this.testDebugExportPort = config.test.receiverPort.orElse(0); - this.devDebugExporter = config.devExporter.enabled; + this.devServicesEnabled = config.enabled(); + this.imageName = config.imageName().orElse(null); + this.fixedExposedPort = config.port().orElse(0); + this.fixedExposedRestPort = config.restPort().orElse(0); + this.shared = config.shared(); + this.serviceName = config.serviceName(); + this.testExporter = config.test().exporter(); + this.testDebugExportPort = config.test().receiverPort().orElse(0); + this.devDebugExporter = config.devExporter().enabled(); this.debugReceiverPort = getPort(); - this.reuse = config.reuse; + this.reuse = config.reuse(); } @Override diff --git a/deployment/src/main/java/io/quarkiverse/zeebe/devservices/ZeebeDevServicesConfig.java b/deployment/src/main/java/io/quarkiverse/zeebe/devservices/ZeebeDevServicesConfig.java index b5177c3..a45bd1e 100644 --- a/deployment/src/main/java/io/quarkiverse/zeebe/devservices/ZeebeDevServicesConfig.java +++ b/deployment/src/main/java/io/quarkiverse/zeebe/devservices/ZeebeDevServicesConfig.java @@ -4,10 +4,10 @@ import java.util.OptionalInt; import io.quarkus.runtime.annotations.ConfigGroup; -import io.quarkus.runtime.annotations.ConfigItem; +import io.smallrye.config.WithDefault; +import io.smallrye.config.WithName; -@ConfigGroup -public class ZeebeDevServicesConfig { +public interface ZeebeDevServicesConfig { /** * If DevServices has been explicitly enabled or disabled. DevServices is generally enabled @@ -16,24 +16,25 @@ public class ZeebeDevServicesConfig { * When DevServices is enabled Quarkus will attempt to automatically configure and start * a database when running in Dev or Test mode and when Docker is running. */ - @ConfigItem(name = "enabled", defaultValue = "true") - public boolean enabled; + @WithName("enabled") + @WithDefault("true") + boolean enabled(); /** * Optional fixed port the dev service will listen to. *

* If not defined, the port will be chosen randomly. */ - @ConfigItem(name = "port") - public OptionalInt port; + @WithName("port") + OptionalInt port(); /** * Optional fixed port the dev service rest service will listen to. *

* If not defined, the port will be chosen randomly. */ - @ConfigItem(name = "rest-port") - public OptionalInt restPort; + @WithName("rest-port") + OptionalInt restPort(); /** * Indicates if the Zeebe server managed by Quarkus Dev Services is shared. @@ -46,8 +47,9 @@ public class ZeebeDevServicesConfig { *

* Container sharing is only used in dev mode. */ - @ConfigItem(name = "shared", defaultValue = "true") - public boolean shared; + @WithName("shared") + @WithDefault("true") + boolean shared(); /** * The value of the {@code quarkus-dev-service-zeebe} label attached to the started container. @@ -59,14 +61,15 @@ public class ZeebeDevServicesConfig { *

* This property is used when you need multiple shared Zeebe servers. */ - @ConfigItem(name = "service-name", defaultValue = "zeebe") - public String serviceName; + @WithName("service-name") + @WithDefault("zeebe") + String serviceName(); /** * The container image name to use, for container based DevServices providers. */ - @ConfigItem(name = "image-name") - public Optional imageName; + @WithName("image-name") + Optional imageName(); /** * Helper to define the stop strategy for containers created by DevServices. @@ -78,53 +81,55 @@ public class ZeebeDevServicesConfig { * * @see Testcontainers Configuration. */ - @ConfigItem(name = "reuse", defaultValue = "false") - public boolean reuse; + @WithName("reuse") + @WithDefault("false") + boolean reuse(); /** * Optional fixed debug export receiver port the dev service will listen to. *

* If not defined, the port will be chosen randomly. */ - @ConfigItem(name = "test") - public TestConfig test; + @WithName("test") + TestConfig test(); /** * Debug dev mode exporter optional configuration. */ - @ConfigItem(name = "dev-exporter") - public DevExporterConfig devExporter; + @WithName("dev-exporter") + DevExporterConfig devExporter(); /** * Zeebe test configuration. */ @ConfigGroup - public static class TestConfig { + interface TestConfig { /** * Optional fixed debug export receiver port the dev service will listen to. *

* If not defined, the port will be chosen randomly. */ - @ConfigItem(name = "receiver-port") - public OptionalInt receiverPort; + @WithName("receiver-port") + OptionalInt receiverPort(); /** * Disable or enable debug exporter for the test. */ - @ConfigItem(name = "exporter", defaultValue = "true") - public boolean exporter; + @WithName("exporter") + @WithDefault("true") + boolean exporter(); } /** * Zeebe dev mode debug exporter configuration. */ - @ConfigGroup - public static class DevExporterConfig { + interface DevExporterConfig { /** * Enable or disable debug exporter. */ - @ConfigItem(name = "enabled", defaultValue = "true") - public boolean enabled; + @WithName("enabled") + @WithDefault("true") + boolean enabled(); } diff --git a/docs/modules/ROOT/pages/includes/attributes.adoc b/docs/modules/ROOT/pages/includes/attributes.adoc index cbe93d2..23a8ad6 100644 --- a/docs/modules/ROOT/pages/includes/attributes.adoc +++ b/docs/modules/ROOT/pages/includes/attributes.adoc @@ -1,5 +1,5 @@ :project-version: 1.5.0 -:quarkus-version: 3.12.3 +:quarkus-version: 3.15.2 :quarkus-mockserver-url: https://github.com/quarkiverse/quarkus-zeebe diff --git a/docs/modules/ROOT/pages/includes/quarkus-zeebe.adoc b/docs/modules/ROOT/pages/includes/quarkus-zeebe.adoc index 94d270a..fe32369 100644 --- a/docs/modules/ROOT/pages/includes/quarkus-zeebe.adoc +++ b/docs/modules/ROOT/pages/includes/quarkus-zeebe.adoc @@ -1,17 +1,14 @@ - -:summaryTableId: quarkus-zeebe +:summaryTableId: quarkus-zeebe_quarkus-zeebe [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] |=== -h|[[quarkus-zeebe_configuration]]link:#quarkus-zeebe_configuration[Configuration property] - +h|[.header-title]##Configuration property## h|Type h|Default -a|icon:lock[title=Fixed at build time] [[quarkus-zeebe_quarkus-zeebe-devservices-enabled]]`link:#quarkus-zeebe_quarkus-zeebe-devservices-enabled[quarkus.zeebe.devservices.enabled]` - +a|icon:lock[title=Fixed at build time] [[quarkus-zeebe_quarkus-zeebe-devservices-enabled]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-devservices-enabled[`quarkus.zeebe.devservices.enabled`]## [.description] -- @@ -19,18 +16,18 @@ If DevServices has been explicitly enabled or disabled. DevServices is generally When DevServices is enabled Quarkus will attempt to automatically configure and start a database when running in Dev or Test mode and when Docker is running. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_DEVSERVICES_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ZEEBE_DEVSERVICES_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -a|icon:lock[title=Fixed at build time] [[quarkus-zeebe_quarkus-zeebe-devservices-port]]`link:#quarkus-zeebe_quarkus-zeebe-devservices-port[quarkus.zeebe.devservices.port]` - +a|icon:lock[title=Fixed at build time] [[quarkus-zeebe_quarkus-zeebe-devservices-port]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-devservices-port[`quarkus.zeebe.devservices.port`]## [.description] -- @@ -38,18 +35,18 @@ Optional fixed port the dev service will listen to. If not defined, the port will be chosen randomly. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_DEVSERVICES_PORT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ZEEBE_DEVSERVICES_PORT+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int | - -a|icon:lock[title=Fixed at build time] [[quarkus-zeebe_quarkus-zeebe-devservices-rest-port]]`link:#quarkus-zeebe_quarkus-zeebe-devservices-rest-port[quarkus.zeebe.devservices.rest-port]` - +a|icon:lock[title=Fixed at build time] [[quarkus-zeebe_quarkus-zeebe-devservices-rest-port]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-devservices-rest-port[`quarkus.zeebe.devservices.rest-port`]## [.description] -- @@ -57,18 +54,18 @@ Optional fixed port the dev service rest service will listen to. If not defined, the port will be chosen randomly. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_DEVSERVICES_REST_PORT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ZEEBE_DEVSERVICES_REST_PORT+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int | - -a|icon:lock[title=Fixed at build time] [[quarkus-zeebe_quarkus-zeebe-devservices-shared]]`link:#quarkus-zeebe_quarkus-zeebe-devservices-shared[quarkus.zeebe.devservices.shared]` - +a|icon:lock[title=Fixed at build time] [[quarkus-zeebe_quarkus-zeebe-devservices-shared]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-devservices-shared[`quarkus.zeebe.devservices.shared`]## [.description] -- @@ -78,18 +75,18 @@ The discovery uses the `quarkus-dev-service-zeebe` label. The value is configure Container sharing is only used in dev mode. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_DEVSERVICES_SHARED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ZEEBE_DEVSERVICES_SHARED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -a|icon:lock[title=Fixed at build time] [[quarkus-zeebe_quarkus-zeebe-devservices-service-name]]`link:#quarkus-zeebe_quarkus-zeebe-devservices-service-name[quarkus.zeebe.devservices.service-name]` - +a|icon:lock[title=Fixed at build time] [[quarkus-zeebe_quarkus-zeebe-devservices-service-name]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-devservices-service-name[`quarkus.zeebe.devservices.service-name`]## [.description] -- @@ -97,52 +94,52 @@ The value of the `quarkus-dev-service-zeebe` label attached to the started conta This property is used when you need multiple shared Zeebe servers. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_DEVSERVICES_SERVICE_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ZEEBE_DEVSERVICES_SERVICE_NAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |`zeebe` - -a|icon:lock[title=Fixed at build time] [[quarkus-zeebe_quarkus-zeebe-devservices-image-name]]`link:#quarkus-zeebe_quarkus-zeebe-devservices-image-name[quarkus.zeebe.devservices.image-name]` - +a|icon:lock[title=Fixed at build time] [[quarkus-zeebe_quarkus-zeebe-devservices-image-name]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-devservices-image-name[`quarkus.zeebe.devservices.image-name`]## [.description] -- The container image name to use, for container based DevServices providers. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_DEVSERVICES_IMAGE_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ZEEBE_DEVSERVICES_IMAGE_NAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a|icon:lock[title=Fixed at build time] [[quarkus-zeebe_quarkus-zeebe-devservices-reuse]]`link:#quarkus-zeebe_quarkus-zeebe-devservices-reuse[quarkus.zeebe.devservices.reuse]` - +a|icon:lock[title=Fixed at build time] [[quarkus-zeebe_quarkus-zeebe-devservices-reuse]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-devservices-reuse[`quarkus.zeebe.devservices.reuse`]## [.description] -- Helper to define the stop strategy for containers created by DevServices. In particular, we don't want to actually stop the containers when they have been flagged for reuse, and when the Test-containers configuration has been explicitly set to allow container reuse. To enable reuse, ass `testcontainers.reuse.enable=true` in your `.testcontainers.properties` file, to be stored in your home. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_DEVSERVICES_REUSE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ZEEBE_DEVSERVICES_REUSE+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a|icon:lock[title=Fixed at build time] [[quarkus-zeebe_quarkus-zeebe-devservices-test-receiver-port]]`link:#quarkus-zeebe_quarkus-zeebe-devservices-test-receiver-port[quarkus.zeebe.devservices.test.receiver-port]` - +a|icon:lock[title=Fixed at build time] [[quarkus-zeebe_quarkus-zeebe-devservices-test-receiver-port]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-devservices-test-receiver-port[`quarkus.zeebe.devservices.test.receiver-port`]## [.description] -- @@ -150,1047 +147,1042 @@ Optional fixed debug export receiver port the dev service will listen to. If not defined, the port will be chosen randomly. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_DEVSERVICES_TEST_RECEIVER_PORT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ZEEBE_DEVSERVICES_TEST_RECEIVER_PORT+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int | - -a|icon:lock[title=Fixed at build time] [[quarkus-zeebe_quarkus-zeebe-devservices-test-exporter]]`link:#quarkus-zeebe_quarkus-zeebe-devservices-test-exporter[quarkus.zeebe.devservices.test.exporter]` - +a|icon:lock[title=Fixed at build time] [[quarkus-zeebe_quarkus-zeebe-devservices-test-exporter]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-devservices-test-exporter[`quarkus.zeebe.devservices.test.exporter`]## [.description] -- Disable or enable debug exporter for the test. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_DEVSERVICES_TEST_EXPORTER+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ZEEBE_DEVSERVICES_TEST_EXPORTER+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -a|icon:lock[title=Fixed at build time] [[quarkus-zeebe_quarkus-zeebe-devservices-dev-exporter-enabled]]`link:#quarkus-zeebe_quarkus-zeebe-devservices-dev-exporter-enabled[quarkus.zeebe.devservices.dev-exporter.enabled]` - +a|icon:lock[title=Fixed at build time] [[quarkus-zeebe_quarkus-zeebe-devservices-dev-exporter-enabled]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-devservices-dev-exporter-enabled[`quarkus.zeebe.devservices.dev-exporter.enabled`]## [.description] -- Enable or disable debug exporter. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_DEVSERVICES_DEV_EXPORTER_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ZEEBE_DEVSERVICES_DEV_EXPORTER_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -a|icon:lock[title=Fixed at build time] [[quarkus-zeebe_quarkus-zeebe-dev-mode-dev-ui-enabled]]`link:#quarkus-zeebe_quarkus-zeebe-dev-mode-dev-ui-enabled[quarkus.zeebe.dev-mode.dev-ui.enabled]` - +a|icon:lock[title=Fixed at build time] [[quarkus-zeebe_quarkus-zeebe-dev-mode-dev-ui-enabled]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-dev-mode-dev-ui-enabled[`quarkus.zeebe.dev-mode.dev-ui.enabled`]## [.description] -- Disable or enabled zeebe dashboard dev-ui. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_DEV_MODE_DEV_UI_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ZEEBE_DEV_MODE_DEV_UI_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -a|icon:lock[title=Fixed at build time] [[quarkus-zeebe_quarkus-zeebe-dev-mode-watch-bpmn-files]]`link:#quarkus-zeebe_quarkus-zeebe-dev-mode-watch-bpmn-files[quarkus.zeebe.dev-mode.watch-bpmn-files]` - +a|icon:lock[title=Fixed at build time] [[quarkus-zeebe_quarkus-zeebe-dev-mode-watch-bpmn-files]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-dev-mode-watch-bpmn-files[`quarkus.zeebe.dev-mode.watch-bpmn-files`]## [.description] -- Observe changes in the bpmn files. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_DEV_MODE_WATCH_BPMN_FILES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ZEEBE_DEV_MODE_WATCH_BPMN_FILES+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -a|icon:lock[title=Fixed at build time] [[quarkus-zeebe_quarkus-zeebe-dev-mode-watch-bpmn-dir]]`link:#quarkus-zeebe_quarkus-zeebe-dev-mode-watch-bpmn-dir[quarkus.zeebe.dev-mode.watch-bpmn-dir]` - +a|icon:lock[title=Fixed at build time] [[quarkus-zeebe_quarkus-zeebe-dev-mode-watch-bpmn-dir]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-dev-mode-watch-bpmn-dir[`quarkus.zeebe.dev-mode.watch-bpmn-dir`]## [.description] -- Observe changes in the bpmn directory and subdirectories. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_DEV_MODE_WATCH_BPMN_DIR+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ZEEBE_DEV_MODE_WATCH_BPMN_DIR+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -a|icon:lock[title=Fixed at build time] [[quarkus-zeebe_quarkus-zeebe-dev-mode-watch-job-worker]]`link:#quarkus-zeebe_quarkus-zeebe-dev-mode-watch-job-worker[quarkus.zeebe.dev-mode.watch-job-worker]` - +a|icon:lock[title=Fixed at build time] [[quarkus-zeebe_quarkus-zeebe-dev-mode-watch-job-worker]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-dev-mode-watch-job-worker[`quarkus.zeebe.dev-mode.watch-job-worker`]## [.description] -- Observe changes in the job worker. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_DEV_MODE_WATCH_JOB_WORKER+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ZEEBE_DEV_MODE_WATCH_JOB_WORKER+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -a|icon:lock[title=Fixed at build time] [[quarkus-zeebe_quarkus-zeebe-resources-enabled]]`link:#quarkus-zeebe_quarkus-zeebe-resources-enabled[quarkus.zeebe.resources.enabled]` - +a|icon:lock[title=Fixed at build time] [[quarkus-zeebe_quarkus-zeebe-resources-enabled]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-resources-enabled[`quarkus.zeebe.resources.enabled`]## [.description] -- Whether an auto scan BPMN process folder. Default true + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_RESOURCES_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ZEEBE_RESOURCES_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -a|icon:lock[title=Fixed at build time] [[quarkus-zeebe_quarkus-zeebe-resources-location]]`link:#quarkus-zeebe_quarkus-zeebe-resources-location[quarkus.zeebe.resources.location]` - +a|icon:lock[title=Fixed at build time] [[quarkus-zeebe_quarkus-zeebe-resources-location]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-resources-location[`quarkus.zeebe.resources.location`]## [.description] -- BPMN process root folder. Default bpmn + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_RESOURCES_LOCATION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ZEEBE_RESOURCES_LOCATION+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |`bpmn` - -a|icon:lock[title=Fixed at build time] [[quarkus-zeebe_quarkus-zeebe-metrics-enabled]]`link:#quarkus-zeebe_quarkus-zeebe-metrics-enabled[quarkus.zeebe.metrics.enabled]` - +a|icon:lock[title=Fixed at build time] [[quarkus-zeebe_quarkus-zeebe-metrics-enabled]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-metrics-enabled[`quarkus.zeebe.metrics.enabled`]## [.description] -- Whether a metrics is enabled in case the micrometer or micro-profile metrics extension is present. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_METRICS_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ZEEBE_METRICS_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -a|icon:lock[title=Fixed at build time] [[quarkus-zeebe_quarkus-zeebe-health-enabled]]`link:#quarkus-zeebe_quarkus-zeebe-health-enabled[quarkus.zeebe.health.enabled]` - +a|icon:lock[title=Fixed at build time] [[quarkus-zeebe_quarkus-zeebe-health-enabled]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-health-enabled[`quarkus.zeebe.health.enabled`]## [.description] -- Whether a health check is published in case the smallrye-health extension is present. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_HEALTH_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ZEEBE_HEALTH_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -a|icon:lock[title=Fixed at build time] [[quarkus-zeebe_quarkus-zeebe-tracing-enabled]]`link:#quarkus-zeebe_quarkus-zeebe-tracing-enabled[quarkus.zeebe.tracing.enabled]` - +a|icon:lock[title=Fixed at build time] [[quarkus-zeebe_quarkus-zeebe-tracing-enabled]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-tracing-enabled[`quarkus.zeebe.tracing.enabled`]## [.description] -- Whether an opentracing is published in case the smallrye-opentracing extension is present. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_TRACING_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ZEEBE_TRACING_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -a| [[quarkus-zeebe_quarkus-zeebe-client-broker-gateway-address]]`link:#quarkus-zeebe_quarkus-zeebe-client-broker-gateway-address[quarkus.zeebe.client.broker.gateway-address]` - +a| [[quarkus-zeebe_quarkus-zeebe-client-broker-gateway-address]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-client-broker-gateway-address[`quarkus.zeebe.client.broker.gateway-address`]## [.description] -- Zeebe gateway address. Default: localhost:26500 + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_CLIENT_BROKER_GATEWAY_ADDRESS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ZEEBE_CLIENT_BROKER_GATEWAY_ADDRESS+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |`localhost:26500` - -a| [[quarkus-zeebe_quarkus-zeebe-client-broker-rest-address]]`link:#quarkus-zeebe_quarkus-zeebe-client-broker-rest-address[quarkus.zeebe.client.broker.rest-address]` - +a| [[quarkus-zeebe_quarkus-zeebe-client-broker-rest-address]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-client-broker-rest-address[`quarkus.zeebe.client.broker.rest-address`]## [.description] -- Zeebe gateway rest address. Default: localhost:8080 + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_CLIENT_BROKER_REST_ADDRESS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ZEEBE_CLIENT_BROKER_REST_ADDRESS+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI] - +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] |`http://0.0.0.0:8080` - -a| [[quarkus-zeebe_quarkus-zeebe-client-broker-keep-alive]]`link:#quarkus-zeebe_quarkus-zeebe-client-broker-keep-alive[quarkus.zeebe.client.broker.keep-alive]` - +a| [[quarkus-zeebe_quarkus-zeebe-client-broker-keep-alive]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-client-broker-keep-alive[`quarkus.zeebe.client.broker.keep-alive`]## [.description] -- Client keep alive duration + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_CLIENT_BROKER_KEEP_ALIVE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ZEEBE_CLIENT_BROKER_KEEP_ALIVE+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`PT45S` - -a| [[quarkus-zeebe_quarkus-zeebe-client-cloud-cluster-id]]`link:#quarkus-zeebe_quarkus-zeebe-client-cloud-cluster-id[quarkus.zeebe.client.cloud.cluster-id]` - +a| [[quarkus-zeebe_quarkus-zeebe-client-cloud-cluster-id]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-client-cloud-cluster-id[`quarkus.zeebe.client.cloud.cluster-id`]## [.description] -- Cloud cluster ID + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_CLIENT_CLOUD_CLUSTER_ID+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ZEEBE_CLIENT_CLOUD_CLUSTER_ID+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-zeebe_quarkus-zeebe-client-cloud-client-id]]`link:#quarkus-zeebe_quarkus-zeebe-client-cloud-client-id[quarkus.zeebe.client.cloud.client-id]` - +a| [[quarkus-zeebe_quarkus-zeebe-client-cloud-client-id]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-client-cloud-client-id[`quarkus.zeebe.client.cloud.client-id`]## [.description] -- Cloud client secret ID + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_CLIENT_CLOUD_CLIENT_ID+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ZEEBE_CLIENT_CLOUD_CLIENT_ID+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-zeebe_quarkus-zeebe-client-cloud-client-secret]]`link:#quarkus-zeebe_quarkus-zeebe-client-cloud-client-secret[quarkus.zeebe.client.cloud.client-secret]` - +a| [[quarkus-zeebe_quarkus-zeebe-client-cloud-client-secret]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-client-cloud-client-secret[`quarkus.zeebe.client.cloud.client-secret`]## [.description] -- Specify a client secret to request an access token. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_CLIENT_CLOUD_CLIENT_SECRET+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ZEEBE_CLIENT_CLOUD_CLIENT_SECRET+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-zeebe_quarkus-zeebe-client-cloud-region]]`link:#quarkus-zeebe_quarkus-zeebe-client-cloud-region[quarkus.zeebe.client.cloud.region]` - +a| [[quarkus-zeebe_quarkus-zeebe-client-cloud-region]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-client-cloud-region[`quarkus.zeebe.client.cloud.region`]## [.description] -- Cloud region + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_CLIENT_CLOUD_REGION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ZEEBE_CLIENT_CLOUD_REGION+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |`bru-2` - -a| [[quarkus-zeebe_quarkus-zeebe-client-cloud-base-url]]`link:#quarkus-zeebe_quarkus-zeebe-client-cloud-base-url[quarkus.zeebe.client.cloud.base-url]` - +a| [[quarkus-zeebe_quarkus-zeebe-client-cloud-base-url]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-client-cloud-base-url[`quarkus.zeebe.client.cloud.base-url`]## [.description] -- Cloud base URL + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_CLIENT_CLOUD_BASE_URL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ZEEBE_CLIENT_CLOUD_BASE_URL+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |`zeebe.camunda.io` - -a| [[quarkus-zeebe_quarkus-zeebe-client-cloud-auth-url]]`link:#quarkus-zeebe_quarkus-zeebe-client-cloud-auth-url[quarkus.zeebe.client.cloud.auth-url]` - +a| [[quarkus-zeebe_quarkus-zeebe-client-cloud-auth-url]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-client-cloud-auth-url[`quarkus.zeebe.client.cloud.auth-url`]## [.description] -- Cloud authorization server URL + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_CLIENT_CLOUD_AUTH_URL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ZEEBE_CLIENT_CLOUD_AUTH_URL+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |`https://login.cloud.camunda.io/oauth/token` - -a| [[quarkus-zeebe_quarkus-zeebe-client-cloud-port]]`link:#quarkus-zeebe_quarkus-zeebe-client-cloud-port[quarkus.zeebe.client.cloud.port]` - +a| [[quarkus-zeebe_quarkus-zeebe-client-cloud-port]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-client-cloud-port[`quarkus.zeebe.client.cloud.port`]## [.description] -- Cloud port + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_CLIENT_CLOUD_PORT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ZEEBE_CLIENT_CLOUD_PORT+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`443` - -a| [[quarkus-zeebe_quarkus-zeebe-client-cloud-credentials-cache-path]]`link:#quarkus-zeebe_quarkus-zeebe-client-cloud-credentials-cache-path[quarkus.zeebe.client.cloud.credentials-cache-path]` - +a| [[quarkus-zeebe_quarkus-zeebe-client-cloud-credentials-cache-path]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-client-cloud-credentials-cache-path[`quarkus.zeebe.client.cloud.credentials-cache-path`]## [.description] -- Cloud credentials cache path + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_CLIENT_CLOUD_CREDENTIALS_CACHE_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ZEEBE_CLIENT_CLOUD_CREDENTIALS_CACHE_PATH+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-zeebe_quarkus-zeebe-client-oauth-client-id]]`link:#quarkus-zeebe_quarkus-zeebe-client-oauth-client-id[quarkus.zeebe.client.oauth.client-id]` - +a| [[quarkus-zeebe_quarkus-zeebe-client-oauth-client-id]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-client-oauth-client-id[`quarkus.zeebe.client.oauth.client-id`]## [.description] -- OAuth client secret ID + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_CLIENT_OAUTH_CLIENT_ID+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ZEEBE_CLIENT_OAUTH_CLIENT_ID+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-zeebe_quarkus-zeebe-client-oauth-client-secret]]`link:#quarkus-zeebe_quarkus-zeebe-client-oauth-client-secret[quarkus.zeebe.client.oauth.client-secret]` - +a| [[quarkus-zeebe_quarkus-zeebe-client-oauth-client-secret]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-client-oauth-client-secret[`quarkus.zeebe.client.oauth.client-secret`]## [.description] -- Specify a client secret to request an access token. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_CLIENT_OAUTH_CLIENT_SECRET+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ZEEBE_CLIENT_OAUTH_CLIENT_SECRET+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-zeebe_quarkus-zeebe-client-oauth-auth-url]]`link:#quarkus-zeebe_quarkus-zeebe-client-oauth-auth-url[quarkus.zeebe.client.oauth.auth-url]` - +a| [[quarkus-zeebe_quarkus-zeebe-client-oauth-auth-url]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-client-oauth-auth-url[`quarkus.zeebe.client.oauth.auth-url`]## [.description] -- Authorization server URL + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_CLIENT_OAUTH_AUTH_URL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ZEEBE_CLIENT_OAUTH_AUTH_URL+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |`https://login.cloud.camunda.io/oauth/token` - -a| [[quarkus-zeebe_quarkus-zeebe-client-oauth-credentials-cache-path]]`link:#quarkus-zeebe_quarkus-zeebe-client-oauth-credentials-cache-path[quarkus.zeebe.client.oauth.credentials-cache-path]` - +a| [[quarkus-zeebe_quarkus-zeebe-client-oauth-credentials-cache-path]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-client-oauth-credentials-cache-path[`quarkus.zeebe.client.oauth.credentials-cache-path`]## [.description] -- Credentials cache path + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_CLIENT_OAUTH_CREDENTIALS_CACHE_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ZEEBE_CLIENT_OAUTH_CREDENTIALS_CACHE_PATH+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-zeebe_quarkus-zeebe-client-oauth-connect-timeout]]`link:#quarkus-zeebe_quarkus-zeebe-client-oauth-connect-timeout[quarkus.zeebe.client.oauth.connect-timeout]` - +a| [[quarkus-zeebe_quarkus-zeebe-client-oauth-connect-timeout]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-client-oauth-connect-timeout[`quarkus.zeebe.client.oauth.connect-timeout`]## [.description] -- OAuth connect timeout + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_CLIENT_OAUTH_CONNECT_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ZEEBE_CLIENT_OAUTH_CONNECT_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`PT5S` - -a| [[quarkus-zeebe_quarkus-zeebe-client-oauth-read-timeout]]`link:#quarkus-zeebe_quarkus-zeebe-client-oauth-read-timeout[quarkus.zeebe.client.oauth.read-timeout]` - +a| [[quarkus-zeebe_quarkus-zeebe-client-oauth-read-timeout]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-client-oauth-read-timeout[`quarkus.zeebe.client.oauth.read-timeout`]## [.description] -- OAuth read timeout + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_CLIENT_OAUTH_READ_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ZEEBE_CLIENT_OAUTH_READ_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`PT5S` - -a| [[quarkus-zeebe_quarkus-zeebe-client-oauth-token-audience]]`link:#quarkus-zeebe_quarkus-zeebe-client-oauth-token-audience[quarkus.zeebe.client.oauth.token-audience]` - +a| [[quarkus-zeebe_quarkus-zeebe-client-oauth-token-audience]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-client-oauth-token-audience[`quarkus.zeebe.client.oauth.token-audience`]## [.description] -- Zeebe token audience + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_CLIENT_OAUTH_TOKEN_AUDIENCE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ZEEBE_CLIENT_OAUTH_TOKEN_AUDIENCE+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-zeebe_quarkus-zeebe-client-auto-complete-max-retries]]`link:#quarkus-zeebe_quarkus-zeebe-client-auto-complete-max-retries[quarkus.zeebe.client.auto-complete.max-retries]` - +a| [[quarkus-zeebe_quarkus-zeebe-client-auto-complete-max-retries]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-client-auto-complete-max-retries[`quarkus.zeebe.client.auto-complete.max-retries`]## [.description] -- Maximum retries for the auto-completion command. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_CLIENT_AUTO_COMPLETE_MAX_RETRIES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ZEEBE_CLIENT_AUTO_COMPLETE_MAX_RETRIES+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`20` - -a| [[quarkus-zeebe_quarkus-zeebe-client-auto-complete-retry-delay]]`link:#quarkus-zeebe_quarkus-zeebe-client-auto-complete-retry-delay[quarkus.zeebe.client.auto-complete.retry-delay]` - +a| [[quarkus-zeebe_quarkus-zeebe-client-auto-complete-retry-delay]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-client-auto-complete-retry-delay[`quarkus.zeebe.client.auto-complete.retry-delay`]## [.description] -- Maximum retries for the auto-completion command. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_CLIENT_AUTO_COMPLETE_RETRY_DELAY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ZEEBE_CLIENT_AUTO_COMPLETE_RETRY_DELAY+++` endif::add-copy-button-to-env-var[] ---|long +-- +|long |`50` - -a| [[quarkus-zeebe_quarkus-zeebe-client-auto-complete-exp-backoff-factor]]`link:#quarkus-zeebe_quarkus-zeebe-client-auto-complete-exp-backoff-factor[quarkus.zeebe.client.auto-complete.exp-backoff-factor]` - +a| [[quarkus-zeebe_quarkus-zeebe-client-auto-complete-exp-backoff-factor]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-client-auto-complete-exp-backoff-factor[`quarkus.zeebe.client.auto-complete.exp-backoff-factor`]## [.description] -- Sets the backoff supplier. The supplier is called to determine the retry delay after each failed request; the worker then waits until the returned delay has elapsed before sending the next request. Note that this is used only for the polling mechanism - failures in the JobHandler should be handled there, and retried there if need be. Sets the backoff multiplication factor. The previous delay is multiplied by this factor. Default is 1.5. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_CLIENT_AUTO_COMPLETE_EXP_BACKOFF_FACTOR+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ZEEBE_CLIENT_AUTO_COMPLETE_EXP_BACKOFF_FACTOR+++` endif::add-copy-button-to-env-var[] ---|double +-- +|double |`1.5` - -a| [[quarkus-zeebe_quarkus-zeebe-client-auto-complete-exp-jitter-factor]]`link:#quarkus-zeebe_quarkus-zeebe-client-auto-complete-exp-jitter-factor[quarkus.zeebe.client.auto-complete.exp-jitter-factor]` - +a| [[quarkus-zeebe_quarkus-zeebe-client-auto-complete-exp-jitter-factor]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-client-auto-complete-exp-jitter-factor[`quarkus.zeebe.client.auto-complete.exp-jitter-factor`]## [.description] -- Sets the jitter factor. The next delay is changed randomly within a range of {plus}/- this factor. For example, if the next delay is calculated to be 1s and the jitterFactor is 0.1 then the actual next delay can be somewhere between 0.9 and 1.1s. Default is 0.2 + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_CLIENT_AUTO_COMPLETE_EXP_JITTER_FACTOR+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ZEEBE_CLIENT_AUTO_COMPLETE_EXP_JITTER_FACTOR+++` endif::add-copy-button-to-env-var[] ---|double +-- +|double |`0.2` - -a| [[quarkus-zeebe_quarkus-zeebe-client-auto-complete-exp-max-delay]]`link:#quarkus-zeebe_quarkus-zeebe-client-auto-complete-exp-max-delay[quarkus.zeebe.client.auto-complete.exp-max-delay]` - +a| [[quarkus-zeebe_quarkus-zeebe-client-auto-complete-exp-max-delay]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-client-auto-complete-exp-max-delay[`quarkus.zeebe.client.auto-complete.exp-max-delay`]## [.description] -- Sets the maximum retry delay. Note that the jitter may push the retry delay over this maximum. Default is 1000ms. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_CLIENT_AUTO_COMPLETE_EXP_MAX_DELAY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ZEEBE_CLIENT_AUTO_COMPLETE_EXP_MAX_DELAY+++` endif::add-copy-button-to-env-var[] ---|long +-- +|long |`1000` - -a| [[quarkus-zeebe_quarkus-zeebe-client-auto-complete-exp-min-delay]]`link:#quarkus-zeebe_quarkus-zeebe-client-auto-complete-exp-min-delay[quarkus.zeebe.client.auto-complete.exp-min-delay]` - +a| [[quarkus-zeebe_quarkus-zeebe-client-auto-complete-exp-min-delay]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-client-auto-complete-exp-min-delay[`quarkus.zeebe.client.auto-complete.exp-min-delay`]## [.description] -- Sets the minimum retry delay. Note that the jitter may push the retry delay below this minimum. Default is 50ms. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_CLIENT_AUTO_COMPLETE_EXP_MIN_DELAY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ZEEBE_CLIENT_AUTO_COMPLETE_EXP_MIN_DELAY+++` endif::add-copy-button-to-env-var[] ---|long +-- +|long |`50` - -a| [[quarkus-zeebe_quarkus-zeebe-client-message-time-to-live]]`link:#quarkus-zeebe_quarkus-zeebe-client-message-time-to-live[quarkus.zeebe.client.message.time-to-live]` - +a| [[quarkus-zeebe_quarkus-zeebe-client-message-time-to-live]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-client-message-time-to-live[`quarkus.zeebe.client.message.time-to-live`]## [.description] -- Client message time to live duration. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_CLIENT_MESSAGE_TIME_TO_LIVE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ZEEBE_CLIENT_MESSAGE_TIME_TO_LIVE+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`PT1H` - -a| [[quarkus-zeebe_quarkus-zeebe-client-security-plaintext]]`link:#quarkus-zeebe_quarkus-zeebe-client-security-plaintext[quarkus.zeebe.client.security.plaintext]` - +a| [[quarkus-zeebe_quarkus-zeebe-client-security-plaintext]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-client-security-plaintext[`quarkus.zeebe.client.security.plaintext`]## [.description] -- Client security plaintext flag. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_CLIENT_SECURITY_PLAINTEXT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ZEEBE_CLIENT_SECURITY_PLAINTEXT+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -a| [[quarkus-zeebe_quarkus-zeebe-client-security-cert-path]]`link:#quarkus-zeebe_quarkus-zeebe-client-security-cert-path[quarkus.zeebe.client.security.cert-path]` - +a| [[quarkus-zeebe_quarkus-zeebe-client-security-cert-path]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-client-security-cert-path[`quarkus.zeebe.client.security.cert-path`]## [.description] -- Specify a path to a certificate with which to validate gateway requests. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_CLIENT_SECURITY_CERT_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ZEEBE_CLIENT_SECURITY_CERT_PATH+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-zeebe_quarkus-zeebe-client-security-override-authority]]`link:#quarkus-zeebe_quarkus-zeebe-client-security-override-authority[quarkus.zeebe.client.security.override-authority]` - +a| [[quarkus-zeebe_quarkus-zeebe-client-security-override-authority]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-client-security-override-authority[`quarkus.zeebe.client.security.override-authority`]## [.description] -- Overrides the authority used with TLS virtual hosting. Specifically, to override hostname verification in the TLS handshake. It does not change what host is actually connected to. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_CLIENT_SECURITY_OVERRIDE_AUTHORITY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ZEEBE_CLIENT_SECURITY_OVERRIDE_AUTHORITY+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-zeebe_quarkus-zeebe-client-job-max-jobs-active]]`link:#quarkus-zeebe_quarkus-zeebe-client-job-max-jobs-active[quarkus.zeebe.client.job.max-jobs-active]` - +a| [[quarkus-zeebe_quarkus-zeebe-client-job-max-jobs-active]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-client-job-max-jobs-active[`quarkus.zeebe.client.job.max-jobs-active`]## [.description] -- Client worker maximum active jobs. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_CLIENT_JOB_MAX_JOBS_ACTIVE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ZEEBE_CLIENT_JOB_MAX_JOBS_ACTIVE+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`32` - -a| [[quarkus-zeebe_quarkus-zeebe-client-job-worker-execution-threads]]`link:#quarkus-zeebe_quarkus-zeebe-client-job-worker-execution-threads[quarkus.zeebe.client.job.worker-execution-threads]` - +a| [[quarkus-zeebe_quarkus-zeebe-client-job-worker-execution-threads]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-client-job-worker-execution-threads[`quarkus.zeebe.client.job.worker-execution-threads`]## [.description] -- Client worker number of threads + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_CLIENT_JOB_WORKER_EXECUTION_THREADS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ZEEBE_CLIENT_JOB_WORKER_EXECUTION_THREADS+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`1` - -a| [[quarkus-zeebe_quarkus-zeebe-client-job-worker-name]]`link:#quarkus-zeebe_quarkus-zeebe-client-job-worker-name[quarkus.zeebe.client.job.worker-name]` - +a| [[quarkus-zeebe_quarkus-zeebe-client-job-worker-name]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-client-job-worker-name[`quarkus.zeebe.client.job.worker-name`]## [.description] -- Client worker default name + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_CLIENT_JOB_WORKER_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ZEEBE_CLIENT_JOB_WORKER_NAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |`default` - -a| [[quarkus-zeebe_quarkus-zeebe-client-job-request-timeout]]`link:#quarkus-zeebe_quarkus-zeebe-client-job-request-timeout[quarkus.zeebe.client.job.request-timeout]` - +a| [[quarkus-zeebe_quarkus-zeebe-client-job-request-timeout]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-client-job-request-timeout[`quarkus.zeebe.client.job.request-timeout`]## [.description] -- Zeebe client request timeout configuration. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_CLIENT_JOB_REQUEST_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ZEEBE_CLIENT_JOB_REQUEST_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`PT45S` - -a| [[quarkus-zeebe_quarkus-zeebe-client-job-default-type]]`link:#quarkus-zeebe_quarkus-zeebe-client-job-default-type[quarkus.zeebe.client.job.default-type]` - +a| [[quarkus-zeebe_quarkus-zeebe-client-job-default-type]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-client-job-default-type[`quarkus.zeebe.client.job.default-type`]## [.description] -- Client worker global type + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_CLIENT_JOB_DEFAULT_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ZEEBE_CLIENT_JOB_DEFAULT_TYPE+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-zeebe_quarkus-zeebe-client-job-timeout]]`link:#quarkus-zeebe_quarkus-zeebe-client-job-timeout[quarkus.zeebe.client.job.timeout]` - +a| [[quarkus-zeebe_quarkus-zeebe-client-job-timeout]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-client-job-timeout[`quarkus.zeebe.client.job.timeout`]## [.description] -- Client job timeout + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_CLIENT_JOB_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ZEEBE_CLIENT_JOB_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`PT5M` - -a| [[quarkus-zeebe_quarkus-zeebe-client-job-pool-interval]]`link:#quarkus-zeebe_quarkus-zeebe-client-job-pool-interval[quarkus.zeebe.client.job.pool-interval]` - +a| [[quarkus-zeebe_quarkus-zeebe-client-job-pool-interval]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-client-job-pool-interval[`quarkus.zeebe.client.job.pool-interval`]## [.description] -- Client job pool interval + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_CLIENT_JOB_POOL_INTERVAL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ZEEBE_CLIENT_JOB_POOL_INTERVAL+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`PT0.100S` - -a| [[quarkus-zeebe_quarkus-zeebe-client-job-exp-backoff-factor]]`link:#quarkus-zeebe_quarkus-zeebe-client-job-exp-backoff-factor[quarkus.zeebe.client.job.exp-backoff-factor]` - +a| [[quarkus-zeebe_quarkus-zeebe-client-job-exp-backoff-factor]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-client-job-exp-backoff-factor[`quarkus.zeebe.client.job.exp-backoff-factor`]## [.description] -- Sets the backoff supplier. The supplier is called to determine the retry delay after each failed request; the worker then waits until the returned delay has elapsed before sending the next request. Note that this is used only for the polling mechanism - failures in the JobHandler should be handled there, and retried there if need be. Sets the backoff multiplication factor. The previous delay is multiplied by this factor. Default is 1.6. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_CLIENT_JOB_EXP_BACKOFF_FACTOR+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ZEEBE_CLIENT_JOB_EXP_BACKOFF_FACTOR+++` endif::add-copy-button-to-env-var[] ---|double +-- +|double |`1.6` - -a| [[quarkus-zeebe_quarkus-zeebe-client-job-exp-jitter-factor]]`link:#quarkus-zeebe_quarkus-zeebe-client-job-exp-jitter-factor[quarkus.zeebe.client.job.exp-jitter-factor]` - +a| [[quarkus-zeebe_quarkus-zeebe-client-job-exp-jitter-factor]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-client-job-exp-jitter-factor[`quarkus.zeebe.client.job.exp-jitter-factor`]## [.description] -- Sets the jitter factor. The next delay is changed randomly within a range of {plus}/- this factor. For example, if the next delay is calculated to be 1s and the jitterFactor is 0.1 then the actual next delay can be somewhere between 0.9 and 1.1s. Default is 0.1 + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_CLIENT_JOB_EXP_JITTER_FACTOR+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ZEEBE_CLIENT_JOB_EXP_JITTER_FACTOR+++` endif::add-copy-button-to-env-var[] ---|double +-- +|double |`0.1` - -a| [[quarkus-zeebe_quarkus-zeebe-client-job-exp-max-delay]]`link:#quarkus-zeebe_quarkus-zeebe-client-job-exp-max-delay[quarkus.zeebe.client.job.exp-max-delay]` - +a| [[quarkus-zeebe_quarkus-zeebe-client-job-exp-max-delay]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-client-job-exp-max-delay[`quarkus.zeebe.client.job.exp-max-delay`]## [.description] -- Sets the maximum retry delay. Note that the jitter may push the retry delay over this maximum. Default is 5000ms. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_CLIENT_JOB_EXP_MAX_DELAY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ZEEBE_CLIENT_JOB_EXP_MAX_DELAY+++` endif::add-copy-button-to-env-var[] ---|long +-- +|long |`5000` - -a| [[quarkus-zeebe_quarkus-zeebe-client-job-exp-min-delay]]`link:#quarkus-zeebe_quarkus-zeebe-client-job-exp-min-delay[quarkus.zeebe.client.job.exp-min-delay]` - +a| [[quarkus-zeebe_quarkus-zeebe-client-job-exp-min-delay]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-client-job-exp-min-delay[`quarkus.zeebe.client.job.exp-min-delay`]## [.description] -- Sets the minimum retry delay. Note that the jitter may push the retry delay below this minimum. Default is 50ms. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_CLIENT_JOB_EXP_MIN_DELAY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ZEEBE_CLIENT_JOB_EXP_MIN_DELAY+++` endif::add-copy-button-to-env-var[] ---|long +-- +|long |`50` - -a| [[quarkus-zeebe_quarkus-zeebe-client-tracing-attributes]]`link:#quarkus-zeebe_quarkus-zeebe-client-tracing-attributes[quarkus.zeebe.client.tracing.attributes]` - +a| [[quarkus-zeebe_quarkus-zeebe-client-tracing-attributes]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-client-tracing-attributes[`quarkus.zeebe.client.tracing.attributes`]## [.description] -- List of span names + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_CLIENT_TRACING_ATTRIBUTES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ZEEBE_CLIENT_TRACING_ATTRIBUTES+++` endif::add-copy-button-to-env-var[] ---|list of string +-- +|list of string | - -a| [[quarkus-zeebe_quarkus-zeebe-client-tenant-default-tenant-id]]`link:#quarkus-zeebe_quarkus-zeebe-client-tenant-default-tenant-id[quarkus.zeebe.client.tenant.default-tenant-id]` - +a| [[quarkus-zeebe_quarkus-zeebe-client-tenant-default-tenant-id]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-client-tenant-default-tenant-id[`quarkus.zeebe.client.tenant.default-tenant-id`]## [.description] -- Zeebe client tenant ID. The tenant identifier which is used for tenant-aware commands when no tenant identifier is set. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_CLIENT_TENANT_DEFAULT_TENANT_ID+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ZEEBE_CLIENT_TENANT_DEFAULT_TENANT_ID+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |`` - -a| [[quarkus-zeebe_quarkus-zeebe-client-tenant-default-job-worker-tenant-ids]]`link:#quarkus-zeebe_quarkus-zeebe-client-tenant-default-job-worker-tenant-ids[quarkus.zeebe.client.tenant.default-job-worker-tenant-ids]` - +a| [[quarkus-zeebe_quarkus-zeebe-client-tenant-default-job-worker-tenant-ids]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-client-tenant-default-job-worker-tenant-ids[`quarkus.zeebe.client.tenant.default-job-worker-tenant-ids`]## [.description] -- Zeebe client default job worker tenant ID's. The tenant identifiers which are used for job-activation commands when no tenant identifiers are set. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_CLIENT_TENANT_DEFAULT_JOB_WORKER_TENANT_IDS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ZEEBE_CLIENT_TENANT_DEFAULT_JOB_WORKER_TENANT_IDS+++` endif::add-copy-button-to-env-var[] ---|list of string +-- +|list of string |`` - -a| [[quarkus-zeebe_quarkus-zeebe-active]]`link:#quarkus-zeebe_quarkus-zeebe-active[quarkus.zeebe.active]` - +a| [[quarkus-zeebe_quarkus-zeebe-active]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-active[`quarkus.zeebe.active`]## [.description] -- Zeebe client is active + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_ACTIVE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ZEEBE_ACTIVE+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -a| [[quarkus-zeebe_quarkus-zeebe-client-workers-workers-enabled]]`link:#quarkus-zeebe_quarkus-zeebe-client-workers-workers-enabled[quarkus.zeebe.client.workers."workers".enabled]` - +a| [[quarkus-zeebe_quarkus-zeebe-client-workers-workers-enabled]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-client-workers-workers-enabled[`quarkus.zeebe.client.workers."workers".enabled`]## [.description] -- Zeebe worker enable or disable flag. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_CLIENT_WORKERS__WORKERS__ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ZEEBE_CLIENT_WORKERS__WORKERS__ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean | - -a| [[quarkus-zeebe_quarkus-zeebe-client-workers-workers-name]]`link:#quarkus-zeebe_quarkus-zeebe-client-workers-workers-name[quarkus.zeebe.client.workers."workers".name]` - +a| [[quarkus-zeebe_quarkus-zeebe-client-workers-workers-name]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-client-workers-workers-name[`quarkus.zeebe.client.workers."workers".name`]## [.description] -- Zeebe worker handler name. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_CLIENT_WORKERS__WORKERS__NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ZEEBE_CLIENT_WORKERS__WORKERS__NAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-zeebe_quarkus-zeebe-client-workers-workers-timeout]]`link:#quarkus-zeebe_quarkus-zeebe-client-workers-workers-timeout[quarkus.zeebe.client.workers."workers".timeout]` - +a| [[quarkus-zeebe_quarkus-zeebe-client-workers-workers-timeout]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-client-workers-workers-timeout[`quarkus.zeebe.client.workers."workers".timeout`]## [.description] -- Zeebe worker timeout. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_CLIENT_WORKERS__WORKERS__TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ZEEBE_CLIENT_WORKERS__WORKERS__TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|long +-- +|long | - -a| [[quarkus-zeebe_quarkus-zeebe-client-workers-workers-max-jobs-active]]`link:#quarkus-zeebe_quarkus-zeebe-client-workers-workers-max-jobs-active[quarkus.zeebe.client.workers."workers".max-jobs-active]` - +a| [[quarkus-zeebe_quarkus-zeebe-client-workers-workers-max-jobs-active]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-client-workers-workers-max-jobs-active[`quarkus.zeebe.client.workers."workers".max-jobs-active`]## [.description] -- Zeebe worker maximum jobs active. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_CLIENT_WORKERS__WORKERS__MAX_JOBS_ACTIVE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ZEEBE_CLIENT_WORKERS__WORKERS__MAX_JOBS_ACTIVE+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int | - -a| [[quarkus-zeebe_quarkus-zeebe-client-workers-workers-request-timeout]]`link:#quarkus-zeebe_quarkus-zeebe-client-workers-workers-request-timeout[quarkus.zeebe.client.workers."workers".request-timeout]` - +a| [[quarkus-zeebe_quarkus-zeebe-client-workers-workers-request-timeout]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-client-workers-workers-request-timeout[`quarkus.zeebe.client.workers."workers".request-timeout`]## [.description] -- Zeebe worker request timeout. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_CLIENT_WORKERS__WORKERS__REQUEST_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ZEEBE_CLIENT_WORKERS__WORKERS__REQUEST_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|long +-- +|long | - -a| [[quarkus-zeebe_quarkus-zeebe-client-workers-workers-poll-interval]]`link:#quarkus-zeebe_quarkus-zeebe-client-workers-workers-poll-interval[quarkus.zeebe.client.workers."workers".poll-interval]` - +a| [[quarkus-zeebe_quarkus-zeebe-client-workers-workers-poll-interval]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-client-workers-workers-poll-interval[`quarkus.zeebe.client.workers."workers".poll-interval`]## [.description] -- Zeebe worker poll interval. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_CLIENT_WORKERS__WORKERS__POLL_INTERVAL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ZEEBE_CLIENT_WORKERS__WORKERS__POLL_INTERVAL+++` endif::add-copy-button-to-env-var[] ---|long +-- +|long | |=== + ifndef::no-duration-note[] [NOTE] -[id='duration-note-anchor-{summaryTableId}'] +[id=duration-note-anchor-quarkus-zeebe_quarkus-zeebe] .About the Duration format ==== To write duration values, use the standard `java.time.Duration` format. @@ -1207,3 +1199,5 @@ In other cases, the simplified format is translated to the `java.time.Duration` * If the value is a number followed by `d`, it is prefixed with `P`. ==== endif::no-duration-note[] + +:!summaryTableId: \ No newline at end of file diff --git a/docs/modules/ROOT/pages/includes/quarkus-zeebe_quarkus.zeebe.adoc b/docs/modules/ROOT/pages/includes/quarkus-zeebe_quarkus.zeebe.adoc new file mode 100644 index 0000000..fe32369 --- /dev/null +++ b/docs/modules/ROOT/pages/includes/quarkus-zeebe_quarkus.zeebe.adoc @@ -0,0 +1,1203 @@ +:summaryTableId: quarkus-zeebe_quarkus-zeebe +[.configuration-legend] +icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime +[.configuration-reference.searchable, cols="80,.^10,.^10"] +|=== + +h|[.header-title]##Configuration property## +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-zeebe_quarkus-zeebe-devservices-enabled]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-devservices-enabled[`quarkus.zeebe.devservices.enabled`]## + +[.description] +-- +If DevServices has been explicitly enabled or disabled. DevServices is generally enabled by default, unless there is an existing configuration present. + +When DevServices is enabled Quarkus will attempt to automatically configure and start a database when running in Dev or Test mode and when Docker is running. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_DEVSERVICES_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ZEEBE_DEVSERVICES_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a|icon:lock[title=Fixed at build time] [[quarkus-zeebe_quarkus-zeebe-devservices-port]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-devservices-port[`quarkus.zeebe.devservices.port`]## + +[.description] +-- +Optional fixed port the dev service will listen to. + +If not defined, the port will be chosen randomly. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_DEVSERVICES_PORT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ZEEBE_DEVSERVICES_PORT+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + +a|icon:lock[title=Fixed at build time] [[quarkus-zeebe_quarkus-zeebe-devservices-rest-port]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-devservices-rest-port[`quarkus.zeebe.devservices.rest-port`]## + +[.description] +-- +Optional fixed port the dev service rest service will listen to. + +If not defined, the port will be chosen randomly. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_DEVSERVICES_REST_PORT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ZEEBE_DEVSERVICES_REST_PORT+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + +a|icon:lock[title=Fixed at build time] [[quarkus-zeebe_quarkus-zeebe-devservices-shared]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-devservices-shared[`quarkus.zeebe.devservices.shared`]## + +[.description] +-- +Indicates if the Zeebe server 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 Zeebe starts a new container. + +The discovery uses the `quarkus-dev-service-zeebe` label. The value is configured using the `service-name` property. + +Container sharing is only used in dev mode. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_DEVSERVICES_SHARED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ZEEBE_DEVSERVICES_SHARED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a|icon:lock[title=Fixed at build time] [[quarkus-zeebe_quarkus-zeebe-devservices-service-name]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-devservices-service-name[`quarkus.zeebe.devservices.service-name`]## + +[.description] +-- +The value of the `quarkus-dev-service-zeebe` 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 Zeebe looks for a container with the `quarkus-dev-service-zeebe` 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-zeebe` label set to the specified value. + +This property is used when you need multiple shared Zeebe servers. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_DEVSERVICES_SERVICE_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ZEEBE_DEVSERVICES_SERVICE_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`zeebe` + +a|icon:lock[title=Fixed at build time] [[quarkus-zeebe_quarkus-zeebe-devservices-image-name]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-devservices-image-name[`quarkus.zeebe.devservices.image-name`]## + +[.description] +-- +The container image name to use, for container based DevServices providers. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_DEVSERVICES_IMAGE_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ZEEBE_DEVSERVICES_IMAGE_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a|icon:lock[title=Fixed at build time] [[quarkus-zeebe_quarkus-zeebe-devservices-reuse]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-devservices-reuse[`quarkus.zeebe.devservices.reuse`]## + +[.description] +-- +Helper to define the stop strategy for containers created by DevServices. In particular, we don't want to actually stop the containers when they have been flagged for reuse, and when the Test-containers configuration has been explicitly set to allow container reuse. To enable reuse, ass `testcontainers.reuse.enable=true` in your `.testcontainers.properties` file, to be stored in your home. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_DEVSERVICES_REUSE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ZEEBE_DEVSERVICES_REUSE+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a|icon:lock[title=Fixed at build time] [[quarkus-zeebe_quarkus-zeebe-devservices-test-receiver-port]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-devservices-test-receiver-port[`quarkus.zeebe.devservices.test.receiver-port`]## + +[.description] +-- +Optional fixed debug export receiver port the dev service will listen to. + +If not defined, the port will be chosen randomly. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_DEVSERVICES_TEST_RECEIVER_PORT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ZEEBE_DEVSERVICES_TEST_RECEIVER_PORT+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + +a|icon:lock[title=Fixed at build time] [[quarkus-zeebe_quarkus-zeebe-devservices-test-exporter]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-devservices-test-exporter[`quarkus.zeebe.devservices.test.exporter`]## + +[.description] +-- +Disable or enable debug exporter for the test. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_DEVSERVICES_TEST_EXPORTER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ZEEBE_DEVSERVICES_TEST_EXPORTER+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a|icon:lock[title=Fixed at build time] [[quarkus-zeebe_quarkus-zeebe-devservices-dev-exporter-enabled]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-devservices-dev-exporter-enabled[`quarkus.zeebe.devservices.dev-exporter.enabled`]## + +[.description] +-- +Enable or disable debug exporter. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_DEVSERVICES_DEV_EXPORTER_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ZEEBE_DEVSERVICES_DEV_EXPORTER_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a|icon:lock[title=Fixed at build time] [[quarkus-zeebe_quarkus-zeebe-dev-mode-dev-ui-enabled]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-dev-mode-dev-ui-enabled[`quarkus.zeebe.dev-mode.dev-ui.enabled`]## + +[.description] +-- +Disable or enabled zeebe dashboard dev-ui. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_DEV_MODE_DEV_UI_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ZEEBE_DEV_MODE_DEV_UI_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a|icon:lock[title=Fixed at build time] [[quarkus-zeebe_quarkus-zeebe-dev-mode-watch-bpmn-files]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-dev-mode-watch-bpmn-files[`quarkus.zeebe.dev-mode.watch-bpmn-files`]## + +[.description] +-- +Observe changes in the bpmn files. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_DEV_MODE_WATCH_BPMN_FILES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ZEEBE_DEV_MODE_WATCH_BPMN_FILES+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a|icon:lock[title=Fixed at build time] [[quarkus-zeebe_quarkus-zeebe-dev-mode-watch-bpmn-dir]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-dev-mode-watch-bpmn-dir[`quarkus.zeebe.dev-mode.watch-bpmn-dir`]## + +[.description] +-- +Observe changes in the bpmn directory and subdirectories. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_DEV_MODE_WATCH_BPMN_DIR+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ZEEBE_DEV_MODE_WATCH_BPMN_DIR+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a|icon:lock[title=Fixed at build time] [[quarkus-zeebe_quarkus-zeebe-dev-mode-watch-job-worker]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-dev-mode-watch-job-worker[`quarkus.zeebe.dev-mode.watch-job-worker`]## + +[.description] +-- +Observe changes in the job worker. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_DEV_MODE_WATCH_JOB_WORKER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ZEEBE_DEV_MODE_WATCH_JOB_WORKER+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a|icon:lock[title=Fixed at build time] [[quarkus-zeebe_quarkus-zeebe-resources-enabled]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-resources-enabled[`quarkus.zeebe.resources.enabled`]## + +[.description] +-- +Whether an auto scan BPMN process folder. Default true + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_RESOURCES_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ZEEBE_RESOURCES_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a|icon:lock[title=Fixed at build time] [[quarkus-zeebe_quarkus-zeebe-resources-location]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-resources-location[`quarkus.zeebe.resources.location`]## + +[.description] +-- +BPMN process root folder. Default bpmn + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_RESOURCES_LOCATION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ZEEBE_RESOURCES_LOCATION+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`bpmn` + +a|icon:lock[title=Fixed at build time] [[quarkus-zeebe_quarkus-zeebe-metrics-enabled]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-metrics-enabled[`quarkus.zeebe.metrics.enabled`]## + +[.description] +-- +Whether a metrics is enabled in case the micrometer or micro-profile metrics extension is present. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_METRICS_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ZEEBE_METRICS_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a|icon:lock[title=Fixed at build time] [[quarkus-zeebe_quarkus-zeebe-health-enabled]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-health-enabled[`quarkus.zeebe.health.enabled`]## + +[.description] +-- +Whether a health check is published in case the smallrye-health extension is present. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_HEALTH_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ZEEBE_HEALTH_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a|icon:lock[title=Fixed at build time] [[quarkus-zeebe_quarkus-zeebe-tracing-enabled]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-tracing-enabled[`quarkus.zeebe.tracing.enabled`]## + +[.description] +-- +Whether an opentracing is published in case the smallrye-opentracing extension is present. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_TRACING_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ZEEBE_TRACING_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-zeebe_quarkus-zeebe-client-broker-gateway-address]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-client-broker-gateway-address[`quarkus.zeebe.client.broker.gateway-address`]## + +[.description] +-- +Zeebe gateway address. Default: localhost:26500 + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_CLIENT_BROKER_GATEWAY_ADDRESS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ZEEBE_CLIENT_BROKER_GATEWAY_ADDRESS+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`localhost:26500` + +a| [[quarkus-zeebe_quarkus-zeebe-client-broker-rest-address]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-client-broker-rest-address[`quarkus.zeebe.client.broker.rest-address`]## + +[.description] +-- +Zeebe gateway rest address. Default: localhost:8080 + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_CLIENT_BROKER_REST_ADDRESS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ZEEBE_CLIENT_BROKER_REST_ADDRESS+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] +|`http://0.0.0.0:8080` + +a| [[quarkus-zeebe_quarkus-zeebe-client-broker-keep-alive]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-client-broker-keep-alive[`quarkus.zeebe.client.broker.keep-alive`]## + +[.description] +-- +Client keep alive duration + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_CLIENT_BROKER_KEEP_ALIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ZEEBE_CLIENT_BROKER_KEEP_ALIVE+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`PT45S` + +a| [[quarkus-zeebe_quarkus-zeebe-client-cloud-cluster-id]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-client-cloud-cluster-id[`quarkus.zeebe.client.cloud.cluster-id`]## + +[.description] +-- +Cloud cluster ID + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_CLIENT_CLOUD_CLUSTER_ID+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ZEEBE_CLIENT_CLOUD_CLUSTER_ID+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-zeebe_quarkus-zeebe-client-cloud-client-id]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-client-cloud-client-id[`quarkus.zeebe.client.cloud.client-id`]## + +[.description] +-- +Cloud client secret ID + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_CLIENT_CLOUD_CLIENT_ID+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ZEEBE_CLIENT_CLOUD_CLIENT_ID+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-zeebe_quarkus-zeebe-client-cloud-client-secret]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-client-cloud-client-secret[`quarkus.zeebe.client.cloud.client-secret`]## + +[.description] +-- +Specify a client secret to request an access token. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_CLIENT_CLOUD_CLIENT_SECRET+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ZEEBE_CLIENT_CLOUD_CLIENT_SECRET+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-zeebe_quarkus-zeebe-client-cloud-region]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-client-cloud-region[`quarkus.zeebe.client.cloud.region`]## + +[.description] +-- +Cloud region + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_CLIENT_CLOUD_REGION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ZEEBE_CLIENT_CLOUD_REGION+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`bru-2` + +a| [[quarkus-zeebe_quarkus-zeebe-client-cloud-base-url]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-client-cloud-base-url[`quarkus.zeebe.client.cloud.base-url`]## + +[.description] +-- +Cloud base URL + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_CLIENT_CLOUD_BASE_URL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ZEEBE_CLIENT_CLOUD_BASE_URL+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`zeebe.camunda.io` + +a| [[quarkus-zeebe_quarkus-zeebe-client-cloud-auth-url]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-client-cloud-auth-url[`quarkus.zeebe.client.cloud.auth-url`]## + +[.description] +-- +Cloud authorization server URL + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_CLIENT_CLOUD_AUTH_URL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ZEEBE_CLIENT_CLOUD_AUTH_URL+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`https://login.cloud.camunda.io/oauth/token` + +a| [[quarkus-zeebe_quarkus-zeebe-client-cloud-port]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-client-cloud-port[`quarkus.zeebe.client.cloud.port`]## + +[.description] +-- +Cloud port + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_CLIENT_CLOUD_PORT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ZEEBE_CLIENT_CLOUD_PORT+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`443` + +a| [[quarkus-zeebe_quarkus-zeebe-client-cloud-credentials-cache-path]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-client-cloud-credentials-cache-path[`quarkus.zeebe.client.cloud.credentials-cache-path`]## + +[.description] +-- +Cloud credentials cache path + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_CLIENT_CLOUD_CREDENTIALS_CACHE_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ZEEBE_CLIENT_CLOUD_CREDENTIALS_CACHE_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-zeebe_quarkus-zeebe-client-oauth-client-id]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-client-oauth-client-id[`quarkus.zeebe.client.oauth.client-id`]## + +[.description] +-- +OAuth client secret ID + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_CLIENT_OAUTH_CLIENT_ID+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ZEEBE_CLIENT_OAUTH_CLIENT_ID+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-zeebe_quarkus-zeebe-client-oauth-client-secret]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-client-oauth-client-secret[`quarkus.zeebe.client.oauth.client-secret`]## + +[.description] +-- +Specify a client secret to request an access token. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_CLIENT_OAUTH_CLIENT_SECRET+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ZEEBE_CLIENT_OAUTH_CLIENT_SECRET+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-zeebe_quarkus-zeebe-client-oauth-auth-url]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-client-oauth-auth-url[`quarkus.zeebe.client.oauth.auth-url`]## + +[.description] +-- +Authorization server URL + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_CLIENT_OAUTH_AUTH_URL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ZEEBE_CLIENT_OAUTH_AUTH_URL+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`https://login.cloud.camunda.io/oauth/token` + +a| [[quarkus-zeebe_quarkus-zeebe-client-oauth-credentials-cache-path]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-client-oauth-credentials-cache-path[`quarkus.zeebe.client.oauth.credentials-cache-path`]## + +[.description] +-- +Credentials cache path + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_CLIENT_OAUTH_CREDENTIALS_CACHE_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ZEEBE_CLIENT_OAUTH_CREDENTIALS_CACHE_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-zeebe_quarkus-zeebe-client-oauth-connect-timeout]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-client-oauth-connect-timeout[`quarkus.zeebe.client.oauth.connect-timeout`]## + +[.description] +-- +OAuth connect timeout + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_CLIENT_OAUTH_CONNECT_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ZEEBE_CLIENT_OAUTH_CONNECT_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`PT5S` + +a| [[quarkus-zeebe_quarkus-zeebe-client-oauth-read-timeout]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-client-oauth-read-timeout[`quarkus.zeebe.client.oauth.read-timeout`]## + +[.description] +-- +OAuth read timeout + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_CLIENT_OAUTH_READ_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ZEEBE_CLIENT_OAUTH_READ_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`PT5S` + +a| [[quarkus-zeebe_quarkus-zeebe-client-oauth-token-audience]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-client-oauth-token-audience[`quarkus.zeebe.client.oauth.token-audience`]## + +[.description] +-- +Zeebe token audience + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_CLIENT_OAUTH_TOKEN_AUDIENCE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ZEEBE_CLIENT_OAUTH_TOKEN_AUDIENCE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-zeebe_quarkus-zeebe-client-auto-complete-max-retries]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-client-auto-complete-max-retries[`quarkus.zeebe.client.auto-complete.max-retries`]## + +[.description] +-- +Maximum retries for the auto-completion command. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_CLIENT_AUTO_COMPLETE_MAX_RETRIES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ZEEBE_CLIENT_AUTO_COMPLETE_MAX_RETRIES+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`20` + +a| [[quarkus-zeebe_quarkus-zeebe-client-auto-complete-retry-delay]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-client-auto-complete-retry-delay[`quarkus.zeebe.client.auto-complete.retry-delay`]## + +[.description] +-- +Maximum retries for the auto-completion command. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_CLIENT_AUTO_COMPLETE_RETRY_DELAY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ZEEBE_CLIENT_AUTO_COMPLETE_RETRY_DELAY+++` +endif::add-copy-button-to-env-var[] +-- +|long +|`50` + +a| [[quarkus-zeebe_quarkus-zeebe-client-auto-complete-exp-backoff-factor]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-client-auto-complete-exp-backoff-factor[`quarkus.zeebe.client.auto-complete.exp-backoff-factor`]## + +[.description] +-- +Sets the backoff supplier. The supplier is called to determine the retry delay after each failed request; the worker then waits until the returned delay has elapsed before sending the next request. Note that this is used only for the polling mechanism - failures in the JobHandler should be handled there, and retried there if need be. Sets the backoff multiplication factor. The previous delay is multiplied by this factor. Default is 1.5. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_CLIENT_AUTO_COMPLETE_EXP_BACKOFF_FACTOR+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ZEEBE_CLIENT_AUTO_COMPLETE_EXP_BACKOFF_FACTOR+++` +endif::add-copy-button-to-env-var[] +-- +|double +|`1.5` + +a| [[quarkus-zeebe_quarkus-zeebe-client-auto-complete-exp-jitter-factor]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-client-auto-complete-exp-jitter-factor[`quarkus.zeebe.client.auto-complete.exp-jitter-factor`]## + +[.description] +-- +Sets the jitter factor. The next delay is changed randomly within a range of {plus}/- this factor. For example, if the next delay is calculated to be 1s and the jitterFactor is 0.1 then the actual next delay can be somewhere between 0.9 and 1.1s. Default is 0.2 + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_CLIENT_AUTO_COMPLETE_EXP_JITTER_FACTOR+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ZEEBE_CLIENT_AUTO_COMPLETE_EXP_JITTER_FACTOR+++` +endif::add-copy-button-to-env-var[] +-- +|double +|`0.2` + +a| [[quarkus-zeebe_quarkus-zeebe-client-auto-complete-exp-max-delay]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-client-auto-complete-exp-max-delay[`quarkus.zeebe.client.auto-complete.exp-max-delay`]## + +[.description] +-- +Sets the maximum retry delay. Note that the jitter may push the retry delay over this maximum. Default is 1000ms. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_CLIENT_AUTO_COMPLETE_EXP_MAX_DELAY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ZEEBE_CLIENT_AUTO_COMPLETE_EXP_MAX_DELAY+++` +endif::add-copy-button-to-env-var[] +-- +|long +|`1000` + +a| [[quarkus-zeebe_quarkus-zeebe-client-auto-complete-exp-min-delay]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-client-auto-complete-exp-min-delay[`quarkus.zeebe.client.auto-complete.exp-min-delay`]## + +[.description] +-- +Sets the minimum retry delay. Note that the jitter may push the retry delay below this minimum. Default is 50ms. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_CLIENT_AUTO_COMPLETE_EXP_MIN_DELAY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ZEEBE_CLIENT_AUTO_COMPLETE_EXP_MIN_DELAY+++` +endif::add-copy-button-to-env-var[] +-- +|long +|`50` + +a| [[quarkus-zeebe_quarkus-zeebe-client-message-time-to-live]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-client-message-time-to-live[`quarkus.zeebe.client.message.time-to-live`]## + +[.description] +-- +Client message time to live duration. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_CLIENT_MESSAGE_TIME_TO_LIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ZEEBE_CLIENT_MESSAGE_TIME_TO_LIVE+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`PT1H` + +a| [[quarkus-zeebe_quarkus-zeebe-client-security-plaintext]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-client-security-plaintext[`quarkus.zeebe.client.security.plaintext`]## + +[.description] +-- +Client security plaintext flag. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_CLIENT_SECURITY_PLAINTEXT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ZEEBE_CLIENT_SECURITY_PLAINTEXT+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-zeebe_quarkus-zeebe-client-security-cert-path]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-client-security-cert-path[`quarkus.zeebe.client.security.cert-path`]## + +[.description] +-- +Specify a path to a certificate with which to validate gateway requests. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_CLIENT_SECURITY_CERT_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ZEEBE_CLIENT_SECURITY_CERT_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-zeebe_quarkus-zeebe-client-security-override-authority]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-client-security-override-authority[`quarkus.zeebe.client.security.override-authority`]## + +[.description] +-- +Overrides the authority used with TLS virtual hosting. Specifically, to override hostname verification in the TLS handshake. It does not change what host is actually connected to. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_CLIENT_SECURITY_OVERRIDE_AUTHORITY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ZEEBE_CLIENT_SECURITY_OVERRIDE_AUTHORITY+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-zeebe_quarkus-zeebe-client-job-max-jobs-active]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-client-job-max-jobs-active[`quarkus.zeebe.client.job.max-jobs-active`]## + +[.description] +-- +Client worker maximum active jobs. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_CLIENT_JOB_MAX_JOBS_ACTIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ZEEBE_CLIENT_JOB_MAX_JOBS_ACTIVE+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`32` + +a| [[quarkus-zeebe_quarkus-zeebe-client-job-worker-execution-threads]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-client-job-worker-execution-threads[`quarkus.zeebe.client.job.worker-execution-threads`]## + +[.description] +-- +Client worker number of threads + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_CLIENT_JOB_WORKER_EXECUTION_THREADS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ZEEBE_CLIENT_JOB_WORKER_EXECUTION_THREADS+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`1` + +a| [[quarkus-zeebe_quarkus-zeebe-client-job-worker-name]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-client-job-worker-name[`quarkus.zeebe.client.job.worker-name`]## + +[.description] +-- +Client worker default name + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_CLIENT_JOB_WORKER_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ZEEBE_CLIENT_JOB_WORKER_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`default` + +a| [[quarkus-zeebe_quarkus-zeebe-client-job-request-timeout]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-client-job-request-timeout[`quarkus.zeebe.client.job.request-timeout`]## + +[.description] +-- +Zeebe client request timeout configuration. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_CLIENT_JOB_REQUEST_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ZEEBE_CLIENT_JOB_REQUEST_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`PT45S` + +a| [[quarkus-zeebe_quarkus-zeebe-client-job-default-type]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-client-job-default-type[`quarkus.zeebe.client.job.default-type`]## + +[.description] +-- +Client worker global type + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_CLIENT_JOB_DEFAULT_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ZEEBE_CLIENT_JOB_DEFAULT_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-zeebe_quarkus-zeebe-client-job-timeout]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-client-job-timeout[`quarkus.zeebe.client.job.timeout`]## + +[.description] +-- +Client job timeout + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_CLIENT_JOB_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ZEEBE_CLIENT_JOB_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`PT5M` + +a| [[quarkus-zeebe_quarkus-zeebe-client-job-pool-interval]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-client-job-pool-interval[`quarkus.zeebe.client.job.pool-interval`]## + +[.description] +-- +Client job pool interval + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_CLIENT_JOB_POOL_INTERVAL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ZEEBE_CLIENT_JOB_POOL_INTERVAL+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`PT0.100S` + +a| [[quarkus-zeebe_quarkus-zeebe-client-job-exp-backoff-factor]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-client-job-exp-backoff-factor[`quarkus.zeebe.client.job.exp-backoff-factor`]## + +[.description] +-- +Sets the backoff supplier. The supplier is called to determine the retry delay after each failed request; the worker then waits until the returned delay has elapsed before sending the next request. Note that this is used only for the polling mechanism - failures in the JobHandler should be handled there, and retried there if need be. Sets the backoff multiplication factor. The previous delay is multiplied by this factor. Default is 1.6. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_CLIENT_JOB_EXP_BACKOFF_FACTOR+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ZEEBE_CLIENT_JOB_EXP_BACKOFF_FACTOR+++` +endif::add-copy-button-to-env-var[] +-- +|double +|`1.6` + +a| [[quarkus-zeebe_quarkus-zeebe-client-job-exp-jitter-factor]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-client-job-exp-jitter-factor[`quarkus.zeebe.client.job.exp-jitter-factor`]## + +[.description] +-- +Sets the jitter factor. The next delay is changed randomly within a range of {plus}/- this factor. For example, if the next delay is calculated to be 1s and the jitterFactor is 0.1 then the actual next delay can be somewhere between 0.9 and 1.1s. Default is 0.1 + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_CLIENT_JOB_EXP_JITTER_FACTOR+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ZEEBE_CLIENT_JOB_EXP_JITTER_FACTOR+++` +endif::add-copy-button-to-env-var[] +-- +|double +|`0.1` + +a| [[quarkus-zeebe_quarkus-zeebe-client-job-exp-max-delay]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-client-job-exp-max-delay[`quarkus.zeebe.client.job.exp-max-delay`]## + +[.description] +-- +Sets the maximum retry delay. Note that the jitter may push the retry delay over this maximum. Default is 5000ms. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_CLIENT_JOB_EXP_MAX_DELAY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ZEEBE_CLIENT_JOB_EXP_MAX_DELAY+++` +endif::add-copy-button-to-env-var[] +-- +|long +|`5000` + +a| [[quarkus-zeebe_quarkus-zeebe-client-job-exp-min-delay]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-client-job-exp-min-delay[`quarkus.zeebe.client.job.exp-min-delay`]## + +[.description] +-- +Sets the minimum retry delay. Note that the jitter may push the retry delay below this minimum. Default is 50ms. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_CLIENT_JOB_EXP_MIN_DELAY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ZEEBE_CLIENT_JOB_EXP_MIN_DELAY+++` +endif::add-copy-button-to-env-var[] +-- +|long +|`50` + +a| [[quarkus-zeebe_quarkus-zeebe-client-tracing-attributes]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-client-tracing-attributes[`quarkus.zeebe.client.tracing.attributes`]## + +[.description] +-- +List of span names + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_CLIENT_TRACING_ATTRIBUTES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ZEEBE_CLIENT_TRACING_ATTRIBUTES+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + +a| [[quarkus-zeebe_quarkus-zeebe-client-tenant-default-tenant-id]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-client-tenant-default-tenant-id[`quarkus.zeebe.client.tenant.default-tenant-id`]## + +[.description] +-- +Zeebe client tenant ID. The tenant identifier which is used for tenant-aware commands when no tenant identifier is set. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_CLIENT_TENANT_DEFAULT_TENANT_ID+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ZEEBE_CLIENT_TENANT_DEFAULT_TENANT_ID+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`` + +a| [[quarkus-zeebe_quarkus-zeebe-client-tenant-default-job-worker-tenant-ids]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-client-tenant-default-job-worker-tenant-ids[`quarkus.zeebe.client.tenant.default-job-worker-tenant-ids`]## + +[.description] +-- +Zeebe client default job worker tenant ID's. The tenant identifiers which are used for job-activation commands when no tenant identifiers are set. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_CLIENT_TENANT_DEFAULT_JOB_WORKER_TENANT_IDS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ZEEBE_CLIENT_TENANT_DEFAULT_JOB_WORKER_TENANT_IDS+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +|`` + +a| [[quarkus-zeebe_quarkus-zeebe-active]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-active[`quarkus.zeebe.active`]## + +[.description] +-- +Zeebe client is active + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_ACTIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ZEEBE_ACTIVE+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-zeebe_quarkus-zeebe-client-workers-workers-enabled]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-client-workers-workers-enabled[`quarkus.zeebe.client.workers."workers".enabled`]## + +[.description] +-- +Zeebe worker enable or disable flag. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_CLIENT_WORKERS__WORKERS__ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ZEEBE_CLIENT_WORKERS__WORKERS__ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +| + +a| [[quarkus-zeebe_quarkus-zeebe-client-workers-workers-name]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-client-workers-workers-name[`quarkus.zeebe.client.workers."workers".name`]## + +[.description] +-- +Zeebe worker handler name. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_CLIENT_WORKERS__WORKERS__NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ZEEBE_CLIENT_WORKERS__WORKERS__NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-zeebe_quarkus-zeebe-client-workers-workers-timeout]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-client-workers-workers-timeout[`quarkus.zeebe.client.workers."workers".timeout`]## + +[.description] +-- +Zeebe worker timeout. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_CLIENT_WORKERS__WORKERS__TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ZEEBE_CLIENT_WORKERS__WORKERS__TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|long +| + +a| [[quarkus-zeebe_quarkus-zeebe-client-workers-workers-max-jobs-active]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-client-workers-workers-max-jobs-active[`quarkus.zeebe.client.workers."workers".max-jobs-active`]## + +[.description] +-- +Zeebe worker maximum jobs active. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_CLIENT_WORKERS__WORKERS__MAX_JOBS_ACTIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ZEEBE_CLIENT_WORKERS__WORKERS__MAX_JOBS_ACTIVE+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + +a| [[quarkus-zeebe_quarkus-zeebe-client-workers-workers-request-timeout]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-client-workers-workers-request-timeout[`quarkus.zeebe.client.workers."workers".request-timeout`]## + +[.description] +-- +Zeebe worker request timeout. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_CLIENT_WORKERS__WORKERS__REQUEST_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ZEEBE_CLIENT_WORKERS__WORKERS__REQUEST_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|long +| + +a| [[quarkus-zeebe_quarkus-zeebe-client-workers-workers-poll-interval]] [.property-path]##link:#quarkus-zeebe_quarkus-zeebe-client-workers-workers-poll-interval[`quarkus.zeebe.client.workers."workers".poll-interval`]## + +[.description] +-- +Zeebe worker poll interval. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ZEEBE_CLIENT_WORKERS__WORKERS__POLL_INTERVAL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ZEEBE_CLIENT_WORKERS__WORKERS__POLL_INTERVAL+++` +endif::add-copy-button-to-env-var[] +-- +|long +| + +|=== + +ifndef::no-duration-note[] +[NOTE] +[id=duration-note-anchor-quarkus-zeebe_quarkus-zeebe] +.About the Duration format +==== +To write duration values, use the standard `java.time.Duration` format. +See the link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html#parse(java.lang.CharSequence)[Duration#parse() Java API documentation] for more information. + +You can also use a simplified format, starting with a number: + +* If the value is only a number, it represents time in seconds. +* If the value is a number followed by `ms`, it represents time in milliseconds. + +In other cases, the simplified format is translated to the `java.time.Duration` format for parsing: + +* If the value is a number followed by `h`, `m`, or `s`, it is prefixed with `PT`. +* If the value is a number followed by `d`, it is prefixed with `P`. +==== +endif::no-duration-note[] + +:!summaryTableId: \ No newline at end of file diff --git a/docs/pom.xml b/docs/pom.xml index 1557551..58186da 100644 --- a/docs/pom.xml +++ b/docs/pom.xml @@ -51,6 +51,14 @@ + + io.quarkus + quarkus-config-doc-maven-plugin + true + + ${project.basedir}/modules/ROOT/pages/includes/ + + maven-resources-plugin @@ -63,11 +71,6 @@ ${project.basedir}/modules/ROOT/pages/includes/ - - ${project.basedir}/../target/asciidoc/generated/config/ - quarkus-zeebe.adoc - false - ${project.basedir}/templates/includes attributes.adoc diff --git a/pom.xml b/pom.xml index bd23487..919c70f 100644 --- a/pom.xml +++ b/pom.xml @@ -23,8 +23,8 @@ HEAD - 3.13.2 - 8.5.5 + 3.15.2 + 8.5.10 3.6.5 17 17 @@ -33,8 +33,8 @@ UTF-8 3.8.1 true - 3.5.1 - 1.11.0 + 3.5.2 + 1.13.0 @@ -95,6 +95,11 @@ quarkus-maven-plugin ${quarkus.version} + + io.quarkus + quarkus-config-doc-maven-plugin + ${quarkus.version} + maven-compiler-plugin ${compiler-plugin.version} diff --git a/runtime/src/main/java/io/quarkiverse/zeebe/runtime/JobWorkerHandler.java b/runtime/src/main/java/io/quarkiverse/zeebe/runtime/JobWorkerHandler.java index 99fd829..fb1d36c 100644 --- a/runtime/src/main/java/io/quarkiverse/zeebe/runtime/JobWorkerHandler.java +++ b/runtime/src/main/java/io/quarkiverse/zeebe/runtime/JobWorkerHandler.java @@ -64,10 +64,10 @@ public JobWorkerHandler(JobWorkerMetadata jobWorkerMetadata, JobWorkerInvoker in if (jobWorkerMetadata.workerValue.autoComplete) { this.backoffSupplier = new ExponentialBackoffBuilderImpl() - .maxDelay(autoCompleteConfig.expMaxDelay) - .minDelay(autoCompleteConfig.expMinDelay) - .backoffFactor(autoCompleteConfig.expBackoffFactor) - .jitterFactor(autoCompleteConfig.expJitterFactor) + .maxDelay(autoCompleteConfig.expMaxDelay()) + .minDelay(autoCompleteConfig.expMinDelay()) + .backoffFactor(autoCompleteConfig.expBackoffFactor()) + .jitterFactor(autoCompleteConfig.expJitterFactor()) .build(); } } @@ -104,7 +104,7 @@ private void doInvoke(JobClient client, ActivatedJob job) { if (jobWorkerMetadata.workerValue.autoComplete) { JobWorkerCommand.createJobWorkerCommand(client, job, result) .request(tracingContext, metricsRecorder, backoffSupplier, exceptionHandler, - autoCompleteConfig.maxRetries, autoCompleteConfig.retryDelay) + autoCompleteConfig.maxRetries(), autoCompleteConfig.retryDelay()) .send(); } return result; @@ -129,7 +129,7 @@ private void doInvoke(JobClient client, ActivatedJob job) { log.info("Caught JobWorker BPMN error on {}", job); JobWorkerCommand.createThrowErrorCommand(client, job, (ZeebeBpmnError) ex) .request(tracingContext, metricsRecorder, backoffSupplier, exceptionHandler, - autoCompleteConfig.maxRetries, autoCompleteConfig.retryDelay) + autoCompleteConfig.maxRetries(), autoCompleteConfig.retryDelay()) .send(); return null; } diff --git a/runtime/src/main/java/io/quarkiverse/zeebe/runtime/ZeebeBuildTimeConfig.java b/runtime/src/main/java/io/quarkiverse/zeebe/runtime/ZeebeBuildTimeConfig.java index 919ab71..d9257db 100644 --- a/runtime/src/main/java/io/quarkiverse/zeebe/runtime/ZeebeBuildTimeConfig.java +++ b/runtime/src/main/java/io/quarkiverse/zeebe/runtime/ZeebeBuildTimeConfig.java @@ -1,89 +1,93 @@ package io.quarkiverse.zeebe.runtime; -import io.quarkus.runtime.annotations.ConfigGroup; -import io.quarkus.runtime.annotations.ConfigItem; import io.quarkus.runtime.annotations.ConfigPhase; import io.quarkus.runtime.annotations.ConfigRoot; +import io.smallrye.config.ConfigMapping; +import io.smallrye.config.WithDefault; +import io.smallrye.config.WithName; -@ConfigRoot(name = "zeebe", phase = ConfigPhase.BUILD_AND_RUN_TIME_FIXED) -public class ZeebeBuildTimeConfig { +@ConfigRoot(phase = ConfigPhase.BUILD_AND_RUN_TIME_FIXED) +@ConfigMapping(prefix = "quarkus.zeebe") +public interface ZeebeBuildTimeConfig { /** * Zeebe client resources configuration. */ - @ConfigItem(name = "resources") - public ResourcesConfig resources = new ResourcesConfig(); + @WithName("resources") + ResourcesConfig resources(); /** * Metrics configuration. */ - @ConfigItem(name = "metrics") - public MetricsConfig metrics = new MetricsConfig(); + @WithName("metrics") + MetricsConfig metrics(); /** * Health check configuration. */ - @ConfigItem(name = "health") - public HealthCheckConfig health = new HealthCheckConfig(); + @WithName("health") + HealthCheckConfig health(); /** * Tracing configuration. */ - @ConfigItem(name = "tracing") - public TracingConfig tracing = new TracingConfig(); + @WithName("tracing") + TracingConfig tracing(); /** * Metrics configuration. */ - @ConfigGroup - public static class MetricsConfig { + interface MetricsConfig { /** * Whether a metrics is enabled in case the micrometer or micro-profile metrics extension is present. */ - @ConfigItem(name = "enabled", defaultValue = "true") - public boolean enabled; + @WithName("enabled") + @WithDefault("true") + boolean enabled(); } /** * Health check configuration. */ - @ConfigGroup - public static class HealthCheckConfig { + interface HealthCheckConfig { /** * Whether a health check is published in case the smallrye-health extension is present. */ - @ConfigItem(name = "enabled", defaultValue = "true") - public boolean enabled; + @WithName("enabled") + @WithDefault("true") + boolean enabled(); } /** * Zeebe client resources configuration. */ - @ConfigGroup - public static class ResourcesConfig { + interface ResourcesConfig { /** * Whether an auto scan BPMN process folder. Default true */ - @ConfigItem(name = "enabled", defaultValue = "true") - public Boolean enabled; + @WithName("enabled") + @WithDefault("true") + Boolean enabled(); + /** * BPMN process root folder. Default bpmn */ - @ConfigItem(name = "location", defaultValue = "bpmn") - public String location; + @WithName("location") + @WithDefault("bpmn") + String location(); } /** * Tracing configuration. */ - @ConfigGroup - public static class TracingConfig { + interface TracingConfig { /** * Whether an opentracing is published in case the smallrye-opentracing extension is present. */ - @ConfigItem(name = "enabled", defaultValue = "true") - public boolean enabled = true; + @WithName("enabled") + @WithDefault("true") + boolean enabled(); } } diff --git a/runtime/src/main/java/io/quarkiverse/zeebe/runtime/ZeebeClientBuilderFactory.java b/runtime/src/main/java/io/quarkiverse/zeebe/runtime/ZeebeClientBuilderFactory.java index 65a3317..5d811bc 100644 --- a/runtime/src/main/java/io/quarkiverse/zeebe/runtime/ZeebeClientBuilderFactory.java +++ b/runtime/src/main/java/io/quarkiverse/zeebe/runtime/ZeebeClientBuilderFactory.java @@ -11,22 +11,22 @@ public static ZeebeClientBuilderImpl createBuilder(ZeebeClientRuntimeConfig conf ZeebeClientBuilderImpl builder = new ZeebeClientBuilderImpl(); builder.gatewayAddress(createGatewayAddress(config)) - .restAddress(config.broker.restAddress) - .defaultTenantId(config.tenant.defaultTenantId) - .defaultJobWorkerTenantIds(config.tenant.defaultJobWorkerTenantIds) - .keepAlive(config.broker.keepAlive) - .defaultJobPollInterval(config.job.pollInterval) - .defaultJobTimeout(config.job.timeout) - .defaultJobWorkerMaxJobsActive(config.job.workerMaxJobsActive) - .defaultJobWorkerName(config.job.workerName) - .defaultMessageTimeToLive(config.message.timeToLive) - .numJobWorkerExecutionThreads(config.job.workerExecutionThreads) - .defaultRequestTimeout(config.job.requestTimeout) + .restAddress(config.broker().restAddress()) + .defaultTenantId(config.tenant().defaultTenantId()) + .defaultJobWorkerTenantIds(config.tenant().defaultJobWorkerTenantIds()) + .keepAlive(config.broker().keepAlive()) + .defaultJobPollInterval(config.job().pollInterval()) + .defaultJobTimeout(config.job().timeout()) + .defaultJobWorkerMaxJobsActive(config.job().workerMaxJobsActive()) + .defaultJobWorkerName(config.job().workerName()) + .defaultMessageTimeToLive(config.message().timeToLive()) + .numJobWorkerExecutionThreads(config.job().workerExecutionThreads()) + .defaultRequestTimeout(config.job().requestTimeout()) .credentialsProvider(getCredentialsProvider(config)); - config.security.overrideAuthority.ifPresent(builder::overrideAuthority); - config.security.certPath.ifPresent(builder::caCertificatePath); - if (config.security.plaintext) { + config.security().overrideAuthority().ifPresent(builder::overrideAuthority); + config.security().certPath().ifPresent(builder::caCertificatePath); + if (config.security().plaintext()) { builder.usePlaintext(); } if (jsonMapper != null) { @@ -36,49 +36,49 @@ public static ZeebeClientBuilderImpl createBuilder(ZeebeClientRuntimeConfig conf } private static String createGatewayAddress(ZeebeClientRuntimeConfig config) { - if (config.cloud.clusterId.isPresent()) { + if (config.cloud().clusterId().isPresent()) { return String.format("%s.%s.%s:%d", - config.cloud.clusterId.get(), - config.cloud.region, - config.cloud.baseUrl, - config.cloud.port); + config.cloud().clusterId().get(), + config.cloud().region(), + config.cloud().baseUrl(), + config.cloud().port()); } - return config.broker.gatewayAddress; + return config.broker().gatewayAddress(); } private static CredentialsProvider getCredentialsProvider(ZeebeClientRuntimeConfig config) { - ZeebeClientRuntimeConfig.CloudConfig cloud = config.cloud; - if (cloud.clientId.isPresent() && cloud.clientSecret.isPresent() && cloud.clusterId.isPresent()) { + ZeebeClientRuntimeConfig.CloudConfig cloud = config.cloud(); + if (cloud.clientId().isPresent() && cloud.clientSecret().isPresent() && cloud.clusterId().isPresent()) { OAuthCredentialsProviderBuilder builder = CredentialsProvider.newCredentialsProviderBuilder(); - builder.authorizationServerUrl(cloud.authUrl); - cloud.clientId.ifPresent(builder::clientId); - cloud.clientSecret.ifPresent(builder::clientSecret); - cloud.credentialsCachePath.ifPresent(builder::credentialsCachePath); - builder.audience(String.format("%s.%s.%s", cloud.clusterId.get(), cloud.region, cloud.baseUrl)); + builder.authorizationServerUrl(cloud.authUrl()); + cloud.clientId().ifPresent(builder::clientId); + cloud.clientSecret().ifPresent(builder::clientSecret); + cloud.credentialsCachePath().ifPresent(builder::credentialsCachePath); + builder.audience(String.format("%s.%s.%s", cloud.clusterId().get(), cloud.region(), cloud.baseUrl())); return builder.build(); } - ZeebeClientRuntimeConfig.OAuthConfig oauth = config.oauth; - if (oauth.clientId.isPresent() && oauth.clientSecret.isPresent()) { + ZeebeClientRuntimeConfig.OAuthConfig oauth = config.oauth(); + if (oauth.clientId().isPresent() && oauth.clientSecret().isPresent()) { OAuthCredentialsProviderBuilder builder = CredentialsProvider.newCredentialsProviderBuilder(); - builder.authorizationServerUrl(oauth.authUrl); - oauth.clientId.ifPresent(builder::clientId); - oauth.clientSecret.ifPresent(builder::clientSecret); - oauth.credentialsCachePath.ifPresent(builder::credentialsCachePath); + builder.authorizationServerUrl(oauth.authUrl()); + oauth.clientId().ifPresent(builder::clientId); + oauth.clientSecret().ifPresent(builder::clientSecret); + oauth.credentialsCachePath().ifPresent(builder::credentialsCachePath); builder.audience(createOauthAudience(config)); // setup connection timeout - builder.connectTimeout(oauth.connectTimeout); - builder.readTimeout(oauth.readTimeout); + builder.connectTimeout(oauth.connectTimeout()); + builder.readTimeout(oauth.readTimeout()); return builder.build(); } return null; } private static String createOauthAudience(ZeebeClientRuntimeConfig config) { - return config.oauth.tokenAudience.orElseGet( - () -> removePortFromAddress(config.broker.gatewayAddress)); + return config.oauth().tokenAudience().orElseGet( + () -> removePortFromAddress(config.broker().gatewayAddress())); } private static String removePortFromAddress(String address) { diff --git a/runtime/src/main/java/io/quarkiverse/zeebe/runtime/ZeebeClientRuntimeConfig.java b/runtime/src/main/java/io/quarkiverse/zeebe/runtime/ZeebeClientRuntimeConfig.java index d2fe82b..1be790e 100644 --- a/runtime/src/main/java/io/quarkiverse/zeebe/runtime/ZeebeClientRuntimeConfig.java +++ b/runtime/src/main/java/io/quarkiverse/zeebe/runtime/ZeebeClientRuntimeConfig.java @@ -3,292 +3,296 @@ import java.net.URI; import java.time.Duration; import java.util.*; -import java.util.concurrent.TimeUnit; import io.camunda.zeebe.client.api.command.CommandWithTenantStep; -import io.camunda.zeebe.client.impl.ZeebeClientBuilderImpl; -import io.quarkus.runtime.annotations.ConfigGroup; -import io.quarkus.runtime.annotations.ConfigItem; +import io.smallrye.config.WithDefault; +import io.smallrye.config.WithName; /** * Zeebe client configuration */ -@ConfigGroup -public class ZeebeClientRuntimeConfig { +public interface ZeebeClientRuntimeConfig { /** * Default client configuration */ - static final ZeebeClientBuilderImpl DEFAULT = (ZeebeClientBuilderImpl) new ZeebeClientBuilderImpl() - .withProperties(new Properties()); - - static final String DEFAULT_AUTH_URL = "https://login.cloud.camunda.io/oauth/token"; + String DEFAULT_AUTH_URL = "https://login.cloud.camunda.io/oauth/token"; /** * Zeebe client broker configuration. */ - @ConfigItem(name = "broker") - public BrokerConfig broker = new BrokerConfig(); + @WithName("broker") + BrokerConfig broker(); /** * Zeebe client cloud configuration. */ - @ConfigItem(name = "cloud") - public CloudConfig cloud = new CloudConfig(); + @WithName("cloud") + CloudConfig cloud(); /** * Zeebe client OAuth configuration. */ - @ConfigItem(name = "oauth") - public OAuthConfig oauth = new OAuthConfig(); + @WithName("oauth") + OAuthConfig oauth(); /** * Zeebe client worker type optional configuration. */ - @ConfigItem(name = "workers") - public Map workers = new HashMap<>(); + @WithName("workers") + Map workers(); /** * Auto-complete configuration for all job handlers */ - @ConfigItem(name = "auto-complete") - public AutoCompleteConfig autoComplete = new AutoCompleteConfig(); + @WithName("auto-complete") + AutoCompleteConfig autoComplete(); /** * Zeebe client message configuration. */ - @ConfigItem(name = "message") - public MessageConfig message = new MessageConfig(); + @WithName("message") + MessageConfig message(); /** * Zeebe client security configuration. */ - @ConfigItem(name = "security") - public SecurityConfig security = new SecurityConfig(); + @WithName("security") + SecurityConfig security(); /** * Zeebe client job configuration. */ - @ConfigItem(name = "job") - public JobConfig job = new JobConfig(); + @WithName("job") + JobConfig job(); /** * Zeebe client tracing configuration. */ - @ConfigItem(name = "tracing") - public TracingConfig tracing = new TracingConfig(); + @WithName("tracing") + TracingConfig tracing(); /** * Zeebe client tenant configuration. */ - @ConfigItem(name = "tenant") - public TenantConfig tenant = new TenantConfig(); + @WithName("tenant") + TenantConfig tenant(); /** * Zeebe client tenant configuration. */ - @ConfigGroup - public static class TenantConfig { + interface TenantConfig { /** * Zeebe client tenant ID. * The tenant identifier which is used for tenant-aware commands when no tenant identifier is set. */ - @ConfigItem(name = "default-tenant-id", defaultValue = CommandWithTenantStep.DEFAULT_TENANT_IDENTIFIER) - public String defaultTenantId = CommandWithTenantStep.DEFAULT_TENANT_IDENTIFIER; + @WithName("default-tenant-id") + @WithDefault(CommandWithTenantStep.DEFAULT_TENANT_IDENTIFIER) + String defaultTenantId(); /** * Zeebe client default job worker tenant ID's. * The tenant identifiers which are used for job-activation commands when no tenant identifiers are set. */ - @ConfigItem(name = "default-job-worker-tenant-ids", defaultValue = CommandWithTenantStep.DEFAULT_TENANT_IDENTIFIER) - public List defaultJobWorkerTenantIds = Collections - .singletonList(CommandWithTenantStep.DEFAULT_TENANT_IDENTIFIER); + @WithName("default-job-worker-tenant-ids") + @WithDefault(CommandWithTenantStep.DEFAULT_TENANT_IDENTIFIER) + List defaultJobWorkerTenantIds(); } /** * Zeebe client broker configuration. */ - @ConfigGroup - public static class BrokerConfig { + interface BrokerConfig { /** * Zeebe gateway address. * Default: localhost:26500 */ - @ConfigItem(name = "gateway-address", defaultValue = "localhost:26500") - public String gatewayAddress; + @WithName("gateway-address") + @WithDefault("localhost:26500") + String gatewayAddress(); /** * Zeebe gateway rest address. * Default: localhost:8080 */ - @ConfigItem(name = "rest-address", defaultValue = "http://0.0.0.0:8080") - public URI restAddress; + @WithName("rest-address") + @WithDefault("http://0.0.0.0:8080") + URI restAddress(); /** * Client keep alive duration */ - @ConfigItem(name = "keep-alive", defaultValue = "PT45S") - public Duration keepAlive = DEFAULT.getKeepAlive(); + @WithName("keep-alive") + @WithDefault("PT45S") + Duration keepAlive(); } /** * Zeebe client cloud configuration. */ - @ConfigGroup - public static class CloudConfig { + interface CloudConfig { /** * Cloud cluster ID */ - @ConfigItem(name = "cluster-id") - public Optional clusterId = Optional.empty(); + @WithName("cluster-id") + Optional clusterId(); /** * Cloud client secret ID */ - @ConfigItem(name = "client-id") - public Optional clientId = Optional.empty(); + @WithName("client-id") + Optional clientId();; /** * Specify a client secret to request an access token. */ - @ConfigItem(name = "client-secret") - public Optional clientSecret; + @WithName("client-secret") + Optional clientSecret(); /** * Cloud region */ - @ConfigItem(name = "region", defaultValue = "bru-2") - public String region = "bru-2"; + @WithName("region") + @WithDefault("bru-2") + String region(); /** * Cloud base URL */ - @ConfigItem(name = "base-url", defaultValue = "zeebe.camunda.io") - public String baseUrl = "zeebe.camunda.io"; + @WithName("base-url") + @WithDefault("zeebe.camunda.io") + String baseUrl(); /** * Cloud authorization server URL */ - @ConfigItem(name = "auth-url", defaultValue = DEFAULT_AUTH_URL) - public String authUrl = DEFAULT_AUTH_URL; + @WithName("auth-url") + @WithDefault(DEFAULT_AUTH_URL) + String authUrl(); /** * Cloud port */ - @ConfigItem(name = "port", defaultValue = "443") - public int port = 443; + @WithName("port") + @WithDefault("443") + int port(); /** * Cloud credentials cache path */ - @ConfigItem(name = "credentials-cache-path") - public Optional credentialsCachePath; + @WithName("credentials-cache-path") + Optional credentialsCachePath(); } /** * Zeebe client message configuration. */ - @ConfigGroup - public static class MessageConfig { + interface MessageConfig { /** * Client message time to live duration. */ - @ConfigItem(name = "time-to-live", defaultValue = "PT1H") - public Duration timeToLive = DEFAULT.getDefaultMessageTimeToLive(); + @WithName("time-to-live") + @WithDefault("PT1H") + Duration timeToLive(); } /** * Zeebe client security configuration. */ - @ConfigGroup - public static class SecurityConfig { + interface SecurityConfig { /** * Client security plaintext flag. */ - @ConfigItem(name = "plaintext", defaultValue = "true") - public boolean plaintext = true; + @WithName("plaintext") + @WithDefault("true") + boolean plaintext(); /** * Specify a path to a certificate with which to validate gateway requests. */ - @ConfigItem(name = "cert-path") - public Optional certPath = Optional.empty(); + @WithName("cert-path") + Optional certPath(); /** * Overrides the authority used with TLS virtual hosting. * Specifically, to override hostname verification in * the TLS handshake. It does not change what host is actually connected to. */ - @ConfigItem(name = "override-authority") - public Optional overrideAuthority = Optional.empty(); + @WithName("override-authority") + Optional overrideAuthority(); } /** * Zeebe client job configuration. */ - @ConfigGroup - public static class JobConfig { + interface JobConfig { /** * Client worker maximum active jobs. */ - @ConfigItem(name = "max-jobs-active", defaultValue = "32") - public Integer workerMaxJobsActive = DEFAULT.getDefaultJobWorkerMaxJobsActive(); + @WithName("max-jobs-active") + @WithDefault("32") + Integer workerMaxJobsActive(); /** * Client worker number of threads */ - @ConfigItem(name = "worker-execution-threads", defaultValue = "1") - public Integer workerExecutionThreads = DEFAULT.getNumJobWorkerExecutionThreads(); + @WithName("worker-execution-threads") + @WithDefault("1") + Integer workerExecutionThreads(); /** * Client worker default name */ - @ConfigItem(name = "worker-name", defaultValue = "default") - public String workerName = DEFAULT.getDefaultJobWorkerName(); + @WithName("worker-name") + @WithDefault("default") + String workerName(); /** * Zeebe client request timeout configuration. */ - @ConfigItem(name = "request-timeout", defaultValue = "PT45S") - public Duration requestTimeout = DEFAULT.getDefaultRequestTimeout(); + @WithName("request-timeout") + @WithDefault("PT45S") + Duration requestTimeout(); /** * Client worker global type */ - @ConfigItem(name = "default-type") - public Optional defaultType; + @WithName("default-type") + Optional defaultType(); /** * Client job timeout */ - @ConfigItem(name = "timeout", defaultValue = "PT5M") - public Duration timeout = DEFAULT.getDefaultJobTimeout(); + @WithName("timeout") + @WithDefault("PT5M") + Duration timeout(); /** * Client job pool interval */ - @ConfigItem(name = "pool-interval", defaultValue = "PT0.100S") - public Duration pollInterval = DEFAULT.getDefaultJobPollInterval(); + @WithName("pool-interval") + @WithDefault("PT0.100S") + Duration pollInterval(); /** * Sets the backoff supplier. The supplier is called to determine the retry delay after each failed request; * the worker then waits until the returned delay has elapsed before sending the next request. * Note that this is used only for the polling mechanism - failures in the JobHandler should be handled there, * and retried there if need be. - * * Sets the backoff multiplication factor. The previous delay is multiplied by this factor. Default is 1.6. * * @see io.camunda.zeebe.client.impl.worker.ExponentialBackoffBuilderImpl */ - @ConfigItem(name = "exp-backoff-factor", defaultValue = "1.6") - public double expBackoffFactor = 1.6; + @WithName("exp-backoff-factor") + @WithDefault("1.6") + double expBackoffFactor(); /** * Sets the jitter factor. The next delay is changed randomly within a range of +/- this factor. @@ -297,8 +301,9 @@ public static class JobConfig { * * @see io.camunda.zeebe.client.impl.worker.ExponentialBackoffBuilderImpl */ - @ConfigItem(name = "exp-jitter-factor", defaultValue = "0.1") - public double expJitterFactor = 0.1; + @WithName("exp-jitter-factor") + @WithDefault("0.1") + double expJitterFactor(); /** * Sets the maximum retry delay. @@ -306,8 +311,9 @@ public static class JobConfig { * * @see io.camunda.zeebe.client.impl.worker.ExponentialBackoffBuilderImpl */ - @ConfigItem(name = "exp-max-delay", defaultValue = "5000") - public long expMaxDelay = TimeUnit.SECONDS.toMillis(5); + @WithName("exp-max-delay") + @WithDefault("5000") + long expMaxDelay(); /** * Sets the minimum retry delay. @@ -315,167 +321,172 @@ public static class JobConfig { * * @see io.camunda.zeebe.client.impl.worker.ExponentialBackoffBuilderImpl */ - @ConfigItem(name = "exp-min-delay", defaultValue = "50") - public long expMinDelay = TimeUnit.MILLISECONDS.toMillis(50); + @WithName("exp-min-delay") + @WithDefault("50") + long expMinDelay(); } /** * Zeebe handler configuration. */ - @ConfigGroup - public static class JobHandlerConfig { + interface JobHandlerConfig { /** * Zeebe worker enable or disable flag. */ - @ConfigItem(name = "enabled") - public Optional enabled; + @WithName("enabled") + Optional enabled(); /** * Zeebe worker handler name. */ - @ConfigItem(name = "name") - public Optional name; + @WithName("name") + Optional name(); /** * Zeebe worker timeout. */ - @ConfigItem(name = "timeout") - public Optional timeout; + @WithName("timeout") + Optional timeout(); /** * Zeebe worker maximum jobs active. */ - @ConfigItem(name = "max-jobs-active") - public Optional maxJobsActive; + @WithName("max-jobs-active") + Optional maxJobsActive(); /** * Zeebe worker request timeout. */ - @ConfigItem(name = "request-timeout") - public Optional requestTimeout; + @WithName("request-timeout") + Optional requestTimeout(); /** * Zeebe worker poll interval. */ - @ConfigItem(name = "poll-interval") - public Optional pollInterval; + @WithName("poll-interval") + Optional pollInterval(); } /** * Zeebe client tracing configuration. */ - @ConfigGroup - public static class TracingConfig { + interface TracingConfig { /** * List of span names */ - @ConfigItem(name = "attributes") - public Optional> attributes; + @WithName("attributes") + Optional> attributes(); } /** * Command configuration will be use only for the auto-completion of job handler. */ - @ConfigGroup - public static class AutoCompleteConfig { + interface AutoCompleteConfig { /** * Maximum retries for the auto-completion command. */ - @ConfigItem(name = "max-retries", defaultValue = "20") - public int maxRetries; + @WithName("max-retries") + @WithDefault("20") + int maxRetries(); /** * Maximum retries for the auto-completion command. */ - @ConfigItem(name = "retry-delay", defaultValue = "50") - public long retryDelay; + @WithName("retry-delay") + @WithDefault("50") + long retryDelay(); /** * Sets the backoff supplier. The supplier is called to determine the retry delay after each failed request; * the worker then waits until the returned delay has elapsed before sending the next request. * Note that this is used only for the polling mechanism - failures in the JobHandler should be handled there, * and retried there if need be. - * * Sets the backoff multiplication factor. The previous delay is multiplied by this factor. Default is 1.5. */ - @ConfigItem(name = "exp-backoff-factor", defaultValue = "1.5") - public double expBackoffFactor = 1.5; + @WithName("exp-backoff-factor") + @WithDefault("1.5") + double expBackoffFactor(); /** * Sets the jitter factor. The next delay is changed randomly within a range of +/- this factor. * For example, if the next delay is calculated to be 1s and the jitterFactor is 0.1 then the actual next * delay can be somewhere between 0.9 and 1.1s. Default is 0.2 */ - @ConfigItem(name = "exp-jitter-factor", defaultValue = "0.2") - public double expJitterFactor = 0.2; + @WithName("exp-jitter-factor") + @WithDefault("0.2") + double expJitterFactor(); /** * Sets the maximum retry delay. * Note that the jitter may push the retry delay over this maximum. Default is 1000ms. */ - @ConfigItem(name = "exp-max-delay", defaultValue = "1000") - public long expMaxDelay = TimeUnit.SECONDS.toMillis(1); + @WithName("exp-max-delay") + @WithDefault("1000") + long expMaxDelay(); /** * Sets the minimum retry delay. * Note that the jitter may push the retry delay below this minimum. Default is 50ms. */ - @ConfigItem(name = "exp-min-delay", defaultValue = "50") - public long expMinDelay = TimeUnit.MILLISECONDS.toMillis(50); + @WithName("exp-min-delay") + @WithDefault("50") + long expMinDelay(); } /** * Zeebe client OAuth configuration. */ - @ConfigGroup - public static class OAuthConfig { + interface OAuthConfig { /** * OAuth client secret ID */ - @ConfigItem(name = "client-id") - public Optional clientId = Optional.empty(); + @WithName("client-id") + Optional clientId(); /** * Specify a client secret to request an access token. */ - @ConfigItem(name = "client-secret") - public Optional clientSecret; + @WithName("client-secret") + Optional clientSecret(); /** * Authorization server URL */ - @ConfigItem(name = "auth-url", defaultValue = DEFAULT_AUTH_URL) - public String authUrl = DEFAULT_AUTH_URL; + @WithName("auth-url") + @WithDefault(DEFAULT_AUTH_URL) + String authUrl(); /** * Credentials cache path */ - @ConfigItem(name = "credentials-cache-path") - public Optional credentialsCachePath; + @WithName("credentials-cache-path") + Optional credentialsCachePath(); /** * OAuth connect timeout */ - @ConfigItem(name = "connect-timeout", defaultValue = "PT5S") - public Duration connectTimeout; + @WithName("connect-timeout") + @WithDefault("PT5S") + Duration connectTimeout(); /** * OAuth read timeout */ - @ConfigItem(name = "read-timeout", defaultValue = "PT5S") - public Duration readTimeout; + @WithName("read-timeout") + @WithDefault("PT5S") + Duration readTimeout(); /** * Zeebe token audience */ - @ConfigItem(name = "token-audience") - public Optional tokenAudience; + @WithName("token-audience") + Optional tokenAudience(); } } diff --git a/runtime/src/main/java/io/quarkiverse/zeebe/runtime/ZeebeClientService.java b/runtime/src/main/java/io/quarkiverse/zeebe/runtime/ZeebeClientService.java index ced33b8..fec652d 100644 --- a/runtime/src/main/java/io/quarkiverse/zeebe/runtime/ZeebeClientService.java +++ b/runtime/src/main/java/io/quarkiverse/zeebe/runtime/ZeebeClientService.java @@ -22,9 +22,9 @@ public class ZeebeClientService { public ZeebeClientService(ZeebeRuntimeConfig config, JsonMapper jsonMapper, @Any Instance interceptors) { - if (config.active) { - log.infof("Creating new zeebe client for %s", config.client.broker.gatewayAddress); - ZeebeClientBuilder builder = ZeebeClientBuilderFactory.createBuilder(config.client, jsonMapper); + if (config.active()) { + log.infof("Creating new zeebe client for %s", config.client().broker().gatewayAddress()); + ZeebeClientBuilder builder = ZeebeClientBuilderFactory.createBuilder(config.client(), jsonMapper); interceptors.forEach(x -> builder.withInterceptors(x::interceptCall)); client = builder.build(); } else { diff --git a/runtime/src/main/java/io/quarkiverse/zeebe/runtime/ZeebeRecorder.java b/runtime/src/main/java/io/quarkiverse/zeebe/runtime/ZeebeRecorder.java index 8ac2ef1..954e5df 100644 --- a/runtime/src/main/java/io/quarkiverse/zeebe/runtime/ZeebeRecorder.java +++ b/runtime/src/main/java/io/quarkiverse/zeebe/runtime/ZeebeRecorder.java @@ -37,8 +37,8 @@ public void init(ZeebeRuntimeConfig config, Collection resources, List attrs = config.client.tracing.attributes.get(); + if (config.client().tracing().attributes().isPresent()) { + List attrs = config.client().tracing().attributes().get(); if (!attrs.isEmpty()) { ZeebeTracing.setAttributes(attrs); } @@ -89,9 +89,9 @@ public void init(ZeebeRuntimeConfig config, Collection resources, List value.name = n); - jonHandlerConfig.enabled.ifPresent(n -> value.enabled = n); - jonHandlerConfig.maxJobsActive.ifPresent(n -> value.maxJobsActive = n); - jonHandlerConfig.timeout.ifPresent(n -> value.timeout = n); - jonHandlerConfig.pollInterval.ifPresent(n -> value.pollInterval = n); - jonHandlerConfig.requestTimeout.ifPresent(n -> value.requestTimeout = n); + jonHandlerConfig.name().ifPresent(n -> value.name = n); + jonHandlerConfig.enabled().ifPresent(n -> value.enabled = n); + jonHandlerConfig.maxJobsActive().ifPresent(n -> value.maxJobsActive = n); + jonHandlerConfig.timeout().ifPresent(n -> value.timeout = n); + jonHandlerConfig.pollInterval().ifPresent(n -> value.pollInterval = n); + jonHandlerConfig.requestTimeout().ifPresent(n -> value.requestTimeout = n); } // skip disabled workers @@ -142,7 +142,7 @@ private static JobWorker buildJobWorker(ZeebeClient client, JobWorkerInvoker invoker = createJobWorkerInvoker(meta.invokerClass); JobWorkerHandler jobHandler = new JobWorkerHandler(meta, invoker, metricsRecorder, exceptionHandler, - config.autoComplete, tracingRecorder); + config.autoComplete(), tracingRecorder); final JobWorkerBuilderStep1.JobWorkerBuilderStep3 builder = client .newWorker() @@ -183,10 +183,10 @@ private static JobWorker buildJobWorker(ZeebeClient client, // setup exponential backoff pull configuration ExponentialBackoffBuilder exp = BackoffSupplier.newBackoffBuilder(); - exp.backoffFactor(config.job.expBackoffFactor); - exp.jitterFactor(config.job.expJitterFactor); - exp.maxDelay(config.job.expMaxDelay); - exp.minDelay(config.job.expMinDelay); + exp.backoffFactor(config.job().expBackoffFactor()); + exp.jitterFactor(config.job().expJitterFactor()); + exp.maxDelay(config.job().expMaxDelay()); + exp.minDelay(config.job().expMinDelay()); builder.backoffSupplier(exp.build()); return builder.open(); diff --git a/runtime/src/main/java/io/quarkiverse/zeebe/runtime/ZeebeRuntimeConfig.java b/runtime/src/main/java/io/quarkiverse/zeebe/runtime/ZeebeRuntimeConfig.java index 8ce8f8a..000d691 100644 --- a/runtime/src/main/java/io/quarkiverse/zeebe/runtime/ZeebeRuntimeConfig.java +++ b/runtime/src/main/java/io/quarkiverse/zeebe/runtime/ZeebeRuntimeConfig.java @@ -1,22 +1,26 @@ package io.quarkiverse.zeebe.runtime; -import io.quarkus.runtime.annotations.ConfigItem; import io.quarkus.runtime.annotations.ConfigPhase; import io.quarkus.runtime.annotations.ConfigRoot; +import io.smallrye.config.ConfigMapping; +import io.smallrye.config.WithDefault; +import io.smallrye.config.WithName; -@ConfigRoot(name = "zeebe", phase = ConfigPhase.RUN_TIME) -public class ZeebeRuntimeConfig { +@ConfigRoot(phase = ConfigPhase.RUN_TIME) +@ConfigMapping(prefix = "quarkus.zeebe") +public interface ZeebeRuntimeConfig { /** * Zeebe client broker configuration. */ - @ConfigItem(name = "client") - public ZeebeClientRuntimeConfig client = new ZeebeClientRuntimeConfig(); + @WithName("client") + ZeebeClientRuntimeConfig client(); /** * Zeebe client is active */ - @ConfigItem(name = "active", defaultValue = "true") - public boolean active = true; + @WithName("active") + @WithDefault("true") + boolean active(); } diff --git a/test/src/main/java/io/quarkiverse/zeebe/test/ZeebeTestResource.java b/test/src/main/java/io/quarkiverse/zeebe/test/ZeebeTestResource.java index 5b5d4ae..92d005d 100644 --- a/test/src/main/java/io/quarkiverse/zeebe/test/ZeebeTestResource.java +++ b/test/src/main/java/io/quarkiverse/zeebe/test/ZeebeTestResource.java @@ -9,13 +9,11 @@ import org.slf4j.LoggerFactory; import io.camunda.zeebe.client.ZeebeClient; -import io.camunda.zeebe.client.ZeebeClientBuilder; +import io.camunda.zeebe.client.impl.ZeebeClientBuilderImpl; import io.camunda.zeebe.process.test.api.RecordStreamSource; import io.camunda.zeebe.process.test.assertions.BpmnAssert; import io.camunda.zeebe.process.test.filters.RecordStream; import io.camunda.zeebe.protocol.record.Record; -import io.quarkiverse.zeebe.runtime.ZeebeClientBuilderFactory; -import io.quarkiverse.zeebe.runtime.ZeebeClientRuntimeConfig; import io.quarkus.test.common.DevServicesContext; import io.quarkus.test.common.QuarkusTestResourceLifecycleManager; import io.zeebe.containers.exporter.DebugReceiver; @@ -53,11 +51,7 @@ public void setIntegrationTestContext(DevServicesContext context) { String gateway = context.devServicesProperties().get("quarkiverse.zeebe.devservices.test.gateway-address"); String restAddress = context.devServicesProperties().get("quarkiverse.zeebe.devservices.test.rest-address"); if (gateway != null || restAddress != null) { - ZeebeClientRuntimeConfig config = new ZeebeClientRuntimeConfig(); - config.broker.gatewayAddress = gateway; - config.broker.restAddress = URI.create(restAddress); - ZeebeClientBuilder builder = ZeebeClientBuilderFactory.createBuilder(config, null); - CLIENT = builder.build(); + CLIENT = createClient(gateway, restAddress); } String receiverPort = context.devServicesProperties().get("quarkiverse.zeebe.devservices.test.receiver-port"); if (receiverPort != null) { @@ -76,4 +70,9 @@ public Iterable> getRecords() { return RECORDS; } } + + private static ZeebeClient createClient(String gateway, String restAddress) { + return new ZeebeClientBuilderImpl().gatewayAddress(gateway).usePlaintext() + .restAddress(URI.create(restAddress)).build(); + } }