Package io.quarkus.smallrye.health.runtime

Interface SmallRyeHealthRuntimeConfig

@ConfigRoot(phase=RUN_TIME)
@ConfigMapping(prefix="quarkus.smallrye-health")
public interface SmallRyeHealthRuntimeConfig

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	SmallRyeHealthRuntimeConfig.Enabled

Method Summary

Modifier and Type	Method	Description
Map<String,String>	additionalProperties()	Additional top-level properties to be included in the resulting JSON object.
Map<String,SmallRyeHealthRuntimeConfig.Enabled>	check()	Specifications of checks that can be disabled.
Optional<Boolean>	enable()	Deprecated, for removal: This API element is subject to removal in a future version. use quarkus.smallrye-health.ui.enabled instead
boolean	enabled()	If Health UI should be enabled.

Method Details

enabled

@WithName("ui.enabled")
@WithDefault("true")
boolean enabled()

If Health UI should be enabled. By default, Health UI is enabled if it is included (see always-include).

enable

@WithName("ui.enable")
@Deprecated(since="3.26",
            forRemoval=true)
Optional<Boolean> enable()

Deprecated, for removal: This API element is subject to removal in a future version.

use quarkus.smallrye-health.ui.enabled instead

If Health UI should be enabled. By default, Health UI is enabled if it is included (see always-include).

additionalProperties

@WithName("additional.property")
@ConfigDocMapKey("property-name")
Map<String,String> additionalProperties()

Additional top-level properties to be included in the resulting JSON object.

check

@ConfigDocMapKey("check-classname")
Map<String,SmallRyeHealthRuntimeConfig.Enabled> check()

Specifications of checks that can be disabled.