ReplaceNetworkPolicyRequest
in package
implements
JsonSerializable
The body of `PUT /api/v1/network/policy`: a **replacement** of the policy.
This is a REPLACEMENT body (§27.4 rule 5): every field is required, so omitting one is a constructor error rather than a silent erasure server-side.
Table of Contents
Interfaces
- JsonSerializable
Properties
- $sessionTimeoutMaxSecs : int
- $version : int
Methods
- __construct() : mixed
- Constructs a ReplaceNetworkPolicyRequest.
- fromArray() : self
- Rebuilds a ReplaceNetworkPolicyRequest 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
$sessionTimeoutMaxSecs read-only
public
int
$sessionTimeoutMaxSecs
$version read-only
public
int
$version
Methods
__construct()
Constructs a ReplaceNetworkPolicyRequest.
public
__construct(int $sessionTimeoutMaxSecs, int $version) : mixed
Parameters
- $sessionTimeoutMaxSecs : int
-
The new cap on a reply profile's
Session-Timeout, in seconds: 300 to 86 400. Lowering it below an existing profile's value is fine (reads clamp); raising it is allowed and audited as a raise. - $version : int
-
The policy's
versionas the caller read it (0for a tenant that has never written one). A stale one is409.
fromArray()
Rebuilds a ReplaceNetworkPolicyRequest 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.