MdsStatusResponse
in package
implements
JsonSerializable
`GET /api/v1/mds/status` response. `no`/`next_update`/`last_refreshed_at` are `None` and `stale` is `false` when MDS has never been ingested — a meaningful, valid answer ("nothing ingested yet"), not an error.
Table of Contents
Interfaces
- JsonSerializable
Properties
- $entryCount : int
- $lastRefreshedAt : string|null
- $nextUpdate : string|null
- $no : int|null
- $stale : bool
Methods
- __construct() : mixed
- Constructs a MdsStatusResponse.
- fromArray() : self
- Rebuilds a MdsStatusResponse from one decoded JSON object.
- jsonSerialize() : array<string, mixed>
- Renders this object for `json_encode()`.
- toArray() : array<string, mixed>
- Renders this object back to its wire form.
Properties
$entryCount read-only
public
int
$entryCount
$lastRefreshedAt read-only
public
string|null
$lastRefreshedAt
= null
$nextUpdate read-only
public
string|null
$nextUpdate
= null
$no read-only
public
int|null
$no
= null
$stale read-only
public
bool
$stale
Methods
__construct()
Constructs a MdsStatusResponse.
public
__construct(int $entryCount, bool $stale[, string|null $lastRefreshedAt = null ][, string|null $nextUpdate = null ][, int|null $no = null ]) : mixed
Parameters
- $entryCount : int
-
the server's
entry_countfield - $stale : bool
-
the server's
stalefield - $lastRefreshedAt : string|null = null
-
the server's
last_refreshed_atfield (optional) - $nextUpdate : string|null = null
-
the server's
next_updatefield (optional) - $no : int|null = null
-
the server's
nofield (optional)
fromArray()
Rebuilds a MdsStatusResponse from one decoded JSON object.
public
static fromArray(array<string, mixed> $data) : self
Parameters
- $data : array<string, mixed>
-
The raw wire object.
Return values
selfjsonSerialize()
Renders this object for `json_encode()`.
public
jsonSerialize() : array<string, mixed>
Any Sensitive it carries stays WRAPPED here, so a log line or a
json_encode($model) in application code prints [SENSITIVE]. The one place a secret
is revealed is ManagementTransport, on the way to the wire
and nowhere else (§27.5).
Return values
array<string, mixed>toArray()
Renders this object back to its wire form.
public
toArray() : array<string, mixed>
§27.4 rule 5: a null property is OMITTED, not emitted as null. On a sparse update those two say opposite things — "leave this alone" versus "set this to nothing" — and only omission means the first.