GetHealthResponse
extends SorobanRpcResponse
in package
General node health check response for the getHealth request.
Tags
Table of Contents
Constants
- HEALTHY = "healthy"
Properties
- $error : SorobanRpcErrorResponse|null
- $jsonResponse : array<string|int, mixed>
- $latestLedger : int|null
- $ledgerRetentionWindow : int|null
- $oldestLedger : int|null
- $status : string|null
Methods
- __construct() : mixed
- fromJson() : static
- Creates an instance from JSON-RPC response data
- getError() : SorobanRpcErrorResponse|null
- getJsonResponse() : array<string|int, mixed>
- getLatestLedger() : int|null
- getLedgerRetentionWindow() : int|null
- getOldestLedger() : int|null
- getStatus() : string|null
- setError() : void
- setJsonResponse() : void
- setLatestLedger() : void
- setLedgerRetentionWindow() : void
- setOldestLedger() : void
- setStatus() : void
Constants
HEALTHY
public
mixed
HEALTHY
= "healthy"
Properties
$error
public
SorobanRpcErrorResponse|null
$error
= null
Error data if the response is an error response
$jsonResponse
public
array<string|int, mixed>
$jsonResponse
$latestLedger
public
int|null
$latestLedger
= null
Most recent known ledger sequence
$ledgerRetentionWindow
public
int|null
$ledgerRetentionWindow
= null
Maximum retention window configured
$oldestLedger
public
int|null
$oldestLedger
= null
Oldest ledger sequence kept in history
$status
public
string|null
$status
= null
Health status of the node (e.g. "healthy")
Methods
__construct()
public
__construct(array<string|int, mixed> $jsonResponse) : mixed
Parameters
- $jsonResponse : array<string|int, mixed>
-
The complete JSON response as data array
fromJson()
Creates an instance from JSON-RPC response data
public
static fromJson(array<string, mixed> $json) : static
Parameters
- $json : array<string, mixed>
-
The JSON response data
Return values
static —The created instance
getError()
public
getError() : SorobanRpcErrorResponse|null
Return values
SorobanRpcErrorResponse|null —Error data if the response is an error response
getJsonResponse()
public
getJsonResponse() : array<string|int, mixed>
Return values
array<string|int, mixed> —The complete JSON response as data array
getLatestLedger()
public
getLatestLedger() : int|null
Return values
int|null —Most recent known ledger sequence
getLedgerRetentionWindow()
public
getLedgerRetentionWindow() : int|null
Return values
int|null —Maximum retention window configured
getOldestLedger()
public
getOldestLedger() : int|null
Return values
int|null —Oldest ledger sequence kept in history
getStatus()
public
getStatus() : string|null
Return values
string|null —Health status of the node (e.g. "healthy")
setError()
public
setError(SorobanRpcErrorResponse|null $error) : void
Parameters
- $error : SorobanRpcErrorResponse|null
-
Error data if the response is an error response
setJsonResponse()
public
setJsonResponse(array<string|int, mixed> $jsonResponse) : void
Parameters
- $jsonResponse : array<string|int, mixed>
-
The complete JSON response as data array
setLatestLedger()
public
setLatestLedger(int|null $latestLedger) : void
Parameters
- $latestLedger : int|null
-
Most recent known ledger sequence
setLedgerRetentionWindow()
public
setLedgerRetentionWindow(int|null $ledgerRetentionWindow) : void
Parameters
- $ledgerRetentionWindow : int|null
-
Maximum retention window configured
setOldestLedger()
public
setOldestLedger(int|null $oldestLedger) : void
Parameters
- $oldestLedger : int|null
-
Oldest ledger sequence kept in history
setStatus()
public
setStatus(string|null $status) : void
Parameters
- $status : string|null
-
Health status of the node