DirectorySyncStatus
in package
implements
JsonSerializable
A read-only view of the sync job's state for one tenant. Counts of what a run did are in its audit rows, and no account id is here.
Table of Contents
Interfaces
- JsonSerializable
Properties
- $fullRequired : bool
- $hasWatermark : bool
- $lastAttemptAt : string|null
- $lastFullRunAt : string|null
- $lastResult : string|null
Methods
- __construct() : mixed
- Constructs a DirectorySyncStatus.
- fromArray() : self
- Rebuilds a DirectorySyncStatus 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
$fullRequired read-only
public
bool
$fullRequired
$hasWatermark read-only
public
bool
$hasWatermark
$lastAttemptAt read-only
public
string|null
$lastAttemptAt
= null
$lastFullRunAt read-only
public
string|null
$lastFullRunAt
= null
$lastResult read-only
public
string|null
$lastResult
= null
Methods
__construct()
Constructs a DirectorySyncStatus.
public
__construct(bool $fullRequired, bool $hasWatermark[, string|null $lastAttemptAt = null ][, string|null $lastFullRunAt = null ][, string|null $lastResult = null ]) : mixed
Parameters
- $fullRequired : bool
-
The next run must be a full reconciliation.
- $hasWatermark : bool
-
An incremental run has a starting point.
- $lastAttemptAt : string|null = null
-
When the last attempt started, or null before the first run. (optional)
- $lastFullRunAt : string|null = null
-
When the last complete full run finished, or null. (optional)
- $lastResult : string|null = null
-
ok,partial,failedorsafety_valve(an open set: decode another value without failing), or null before the first run. (optional)
fromArray()
Rebuilds a DirectorySyncStatus 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.