HealthController class
The controller responsible for handling health check requests. It defines a GET endpoint that triggers the health check process and returns the results.
Constructors
- HealthController([String? path])
- Creates a HealthController with an optional custom path for the health check endpoint. If no path is provided, it defaults to '/health'.
Properties
-
exceptionFilters
→ Set<
ExceptionFilter> -
The
exceptionFiltersproperty contains the exception filters of the controller.no setterinherited - hashCode → int
-
The hash code for this object.
no setterinherited
- hooks → HooksContainer
-
The
hooksContainerproperty contains the hooks container of the controller.finalinherited -
metadata
→ List<
Metadata> -
The
metadataproperty contains the metadata of the controller.no setterinherited - path → String
-
The
pathproperty contains the path of the controller.finalinherited -
pipes
↔ List<
Pipe> -
The list of pipes to be applied.
getter/setter pairinherited
-
routes
→ Map<
String, RestRouteHandlerSpec> -
The
routesproperty contains the routes of the controller.no setterinherited - runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- version → int?
-
The
versionproperty contains the version of the controller.no setterinherited
Methods
-
get(
String routeId) → RestRouteHandlerSpec? -
The
getmethod is used to get a route.inherited -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
on<
T, B> (Route route, Future< T> handler(RequestContext<B> context), {bool shouldValidateMultipart = false}) → void -
The
onmethod is used to register a route.inherited -
onStatic<
T> (Route route, T handler) → void -
The
onStaticmethod is used to register a static route. It takes aRouteand a Object value.inherited -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited