Package io.quarkus.smallrye.health.deployment

Class SmallRyeHealthBuildTimeConfig

java.lang.Object

io.quarkus.smallrye.health.deployment.SmallRyeHealthBuildTimeConfig

@ConfigRoot(name="smallrye-health")
public class SmallRyeHealthBuildTimeConfig
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
boolean	enabled	Activate or disable this extension.
Optional<Boolean>	extensionsEnabled	Whether extensions published health check should be enabled.
Optional<Boolean>	openapiIncluded	Whether to include the Liveness and Readiness Health endpoints in the generated OpenAPI document

Constructor Summary

Constructors

Constructor	Description
SmallRyeHealthBuildTimeConfig()

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

enabled

@ConfigItem(defaultValue="true")
public boolean enabled

Activate or disable this extension. Disabling this extension means that no health related information is exposed.

extensionsEnabled

@ConfigItem(name="extensions.enabled",
            defaultValueDocumentation="true")
public Optional<Boolean> extensionsEnabled

Whether extensions published health check should be enabled.

openapiIncluded

@ConfigItem(name="openapi.included",
            defaultValueDocumentation="false")
public Optional<Boolean> openapiIncluded

Whether to include the Liveness and Readiness Health endpoints in the generated OpenAPI document

Constructor Details

SmallRyeHealthBuildTimeConfig

public SmallRyeHealthBuildTimeConfig()