ScimTargetDeliveryState
in package
implements
JsonSerializable
A target's delivery state, as `GET` projects it. Fixed vocabulary only: the failure reason is one of the deliverer's phrases, never a URL, a response body or a value.
Table of Contents
Interfaces
- JsonSerializable
Properties
- $consecutiveFailures : int
- $deadLetteredTotal : int
- $lastFailureAt : string|null
- $lastFailureReason : string|null
- $lastReconciledAt : string|null
- $lastSuccessAt : string|null
Methods
- __construct() : mixed
- Constructs a ScimTargetDeliveryState.
- fromArray() : self
- Rebuilds a ScimTargetDeliveryState 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
$consecutiveFailures read-only
public
int
$consecutiveFailures
$deadLetteredTotal read-only
public
int
$deadLetteredTotal
$lastFailureAt read-only
public
string|null
$lastFailureAt
= null
$lastFailureReason read-only
public
string|null
$lastFailureReason
= null
$lastReconciledAt read-only
public
string|null
$lastReconciledAt
= null
$lastSuccessAt read-only
public
string|null
$lastSuccessAt
= null
Methods
__construct()
Constructs a ScimTargetDeliveryState.
public
__construct(int $consecutiveFailures, int $deadLetteredTotal[, string|null $lastFailureAt = null ][, string|null $lastFailureReason = null ][, string|null $lastReconciledAt = null ][, string|null $lastSuccessAt = null ]) : mixed
Parameters
- $consecutiveFailures : int
-
Failed attempts since the last success.
- $deadLetteredTotal : int
-
Deliveries dead-lettered over the target's lifetime.
- $lastFailureAt : string|null = null
-
When a delivery attempt last failed or was dead-lettered. (optional)
- $lastFailureReason : string|null = null
-
Why, in the deliverer's fixed vocabulary. (optional)
- $lastReconciledAt : string|null = null
-
When reconciliation last ran. (optional)
- $lastSuccessAt : string|null = null
-
When a delivery last succeeded. (optional)
fromArray()
Rebuilds a ScimTargetDeliveryState 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.