Index

A C E F H I L O R S T V W
All Classes and Interfaces|All Packages|Serialized Form

A

AsyncHealthCheck - Interface in io.smallrye.health.api

The async health check procedure interface.

C

call() - Method in interface io.smallrye.health.api.AsyncHealthCheck

Invokes the health check procedure provided by the implementation of this interface.

E

equals(Object) - Method in record class io.smallrye.health.api.event.HealthStatusChangeEvent

Indicates whether some other object is "equal to" this one.

F

filter(JsonObject) - Method in interface io.smallrye.health.api.HealthContentFilter

Filters (removes, adds, or modifies) fields in the provided JsonObject.

H

hashCode() - Method in record class io.smallrye.health.api.event.HealthStatusChangeEvent

Returns a hash code value for this object.

HealthContentFilter - Interface in io.smallrye.health.api

Implementations of this interface are invoked prior the health report to filter(remove, add, or modify) fields in the returned JSON object.

HealthGroup - Annotation Interface in io.smallrye.health.api

This qualifier is used to define a custom Health Check procedure by applying a group name to it

HealthGroup.Literal - Class in io.smallrye.health.api

Support inline instantiation of the HealthGroup qualifier.

HealthGroups - Annotation Interface in io.smallrye.health.api

This annotation allow to repeat HealthGroup qualifier

HealthRegistry - Interface in io.smallrye.health.api

Programmatic API for the dynamic registrations and removals of health check procedures.

HealthStatusChangeEvent - Record Class in io.smallrye.health.api.event

Event for the health state changes.

HealthStatusChangeEvent(HealthType, HealthCheckResponse.Status) - Constructor for record class io.smallrye.health.api.event.HealthStatusChangeEvent

HealthStatusChangeEvent(Instant, HealthType, HealthCheckResponse.Status) - Constructor for record class io.smallrye.health.api.event.HealthStatusChangeEvent

Creates an instance of a HealthStatusChangeEvent record class.

HealthStatusChangeEvent(HealthCheckResponse.Status) - Constructor for record class io.smallrye.health.api.event.HealthStatusChangeEvent

healthType() - Method in record class io.smallrye.health.api.event.HealthStatusChangeEvent

Returns the value of the healthType record component.

HealthType - Enum Class in io.smallrye.health.api

The default types of health representing out-of-the-box health check groups.

I

INSTANCE - Static variable in class io.smallrye.health.api.Wellness.Literal

io.smallrye.health.api - package io.smallrye.health.api

io.smallrye.health.api.event - package io.smallrye.health.api.event

L

Literal() - Constructor for class io.smallrye.health.api.Wellness.Literal

LIVENESS - Enum constant in enum class io.smallrye.health.api.HealthType

O

of(String) - Static method in class io.smallrye.health.api.HealthGroup.Literal

R

READINESS - Enum constant in enum class io.smallrye.health.api.HealthType

register(AsyncHealthCheck) - Method in interface io.smallrye.health.api.HealthRegistry

Asynchronous variant of HealthRegistry.register(HealthCheck).

register(String, AsyncHealthCheck) - Method in interface io.smallrye.health.api.HealthRegistry

Asynchronous variant of the HealthRegistry.register(String, HealthCheck).

register(String, HealthCheck) - Method in interface io.smallrye.health.api.HealthRegistry

Programmatic registration of a HealthCheck instances.

register(HealthCheck) - Method in interface io.smallrye.health.api.HealthRegistry

Programmatic registration of a HealthCheck intances with the id set to to the health check class name.

remove(AsyncHealthCheck) - Method in interface io.smallrye.health.api.HealthRegistry

Asynchronous variant of HealthRegistry.remove(HealthCheck).

remove(String) - Method in interface io.smallrye.health.api.HealthRegistry

Programmatic removal of a programmatically registered check (HealthCheck or AsyncHealthCheck) instances.

remove(HealthCheck) - Method in interface io.smallrye.health.api.HealthRegistry

Programmatic removal of a programmatically registered HealthCheck instances with the id set to the the health check class name.

S

STARTUP - Enum constant in enum class io.smallrye.health.api.HealthType

status() - Method in record class io.smallrye.health.api.event.HealthStatusChangeEvent

Returns the value of the status record component.

T

timestamp() - Method in record class io.smallrye.health.api.event.HealthStatusChangeEvent

Returns the value of the timestamp record component.

toString() - Method in record class io.smallrye.health.api.event.HealthStatusChangeEvent

Returns a string representation of this record class.

V

value() - Method in class io.smallrye.health.api.HealthGroup.Literal

value() - Element in annotation interface io.smallrye.health.api.HealthGroup

value() - Element in annotation interface io.smallrye.health.api.HealthGroups

valueOf(String) - Static method in enum class io.smallrye.health.api.HealthType

Returns the enum constant of this class with the specified name.

values() - Static method in enum class io.smallrye.health.api.HealthType

Returns an array containing the constants of this enum class, in the order they are declared.

W

Wellness - Annotation Interface in io.smallrye.health.api

This qualifier is used to define a wellness Health Check procedure

WELLNESS - Enum constant in enum class io.smallrye.health.api.HealthType

Wellness.Literal - Class in io.smallrye.health.api

Support inline instantiation of the Wellness qualifier.

A C E F H I L O R S T V W
All Classes and Interfaces|All Packages|Serialized Form