ReplaceNetworkSegmentRequest
in package
implements
JsonSerializable
The body of `PUT /api/v1/network/segments/{id}`: a **replacement** of the envelope. The kind and the place in the tree do not change.
This is a REPLACEMENT body (§27.4 rule 5): what it omits is not preserved. The required members are constructor parameters, so omitting one is a constructor error; an optional member left unset is omitted from the wire and takes its default server-side.
Table of Contents
Interfaces
- JsonSerializable
Properties
- $enabled : bool
- $filterIds : array<string|int, mixed>
- $rank : int|null
- $version : int
- $vlanId : int
Methods
- __construct() : mixed
- Constructs a ReplaceNetworkSegmentRequest.
- fromArray() : self
- Rebuilds a ReplaceNetworkSegmentRequest 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
$enabled read-only
public
bool
$enabled
$filterIds read-only
public
array<string|int, mixed>
$filterIds
$rank read-only
public
int|null
$rank
= null
$version read-only
public
int
$version
$vlanId read-only
public
int
$vlanId
Methods
__construct()
Constructs a ReplaceNetworkSegmentRequest.
public
__construct(bool $enabled, array<int, string> $filterIds, int $version, int $vlanId[, int|null $rank = null ]) : mixed
Parameters
- $enabled : bool
-
Whether the segment is a placement candidate.
- $filterIds : array<int, string>
-
The
Filter-Idnames the segment's profile may choose from. Removing the one the profile uses is409, naming the profile. - $version : int
-
The segment's
versionas the caller read it. A stale one is409. - $vlanId : int
-
The VLAN (1 to 4094).
- $rank : int|null = null
-
The placement rank: required for an
accesssegment, absent for aquarantineone. (optional)
fromArray()
Rebuilds a ReplaceNetworkSegmentRequest 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.