Nexus API Reference

HealthStatus
in package

Read onlyYes
FinalYes
Tags
psalm-api

Immutable result of a single HealthCheck.

Three states inspired by Kubernetes / Spring Boot Actuator:

  • up — check passed
  • degraded — works but slow / partial / using fallback
  • down — failed; /health returns 503 if any check is down

detail is a free-form scalar map serialised into the /health JSON response so dashboards can surface backing-service info (last seen timestamps, hit ratios, queue depths) without parsing log lines.

Table of Contents

Properties

$detail  : array<string|int, mixed>
$state  : State

Methods

__construct()  : mixed
degraded()  : self
down()  : self
isUp()  : bool
up()  : self

Properties

Methods

__construct()

public __construct(State $state[, array<string, scalar|null> $detail = [] ]) : mixed
Parameters
$state : State
$detail : array<string, scalar|null> = []

degraded()

public static degraded([array<string, scalar|null> $detail = [] ]) : self
Parameters
$detail : array<string, scalar|null> = []
Return values
self

down()

public static down([array<string, scalar|null> $detail = [] ]) : self
Parameters
$detail : array<string, scalar|null> = []
Return values
self

up()

public static up([array<string, scalar|null> $detail = [] ]) : self
Parameters
$detail : array<string, scalar|null> = []
Return values
self 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results