AXIAM PHP SDK

NetworkSegmentResponse
in package
implements JsonSerializable

FinalYes

A network segment, as the management API returns it.

Table of Contents

Interfaces

JsonSerializable

Properties

$createdAt  : string
$createdBy  : string
$enabled  : bool
$filterIds  : array<string|int, mixed>
$id  : string
$kind  : NetworkSegmentKind
$name  : string
$path  : string
$rank  : int|null
$siteKey  : string
$tenantId  : string
$updatedAt  : string
$updatedBy  : string
$version  : int
$vlanId  : int

Methods

__construct()  : mixed
Constructs a NetworkSegmentResponse.
fromArray()  : self
Rebuilds a NetworkSegmentResponse 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.
unknownEnumValue()  : string|null
The string the server sent for an open-enum member this SDK has no name for, or `null`.

Properties

Methods

__construct()

Constructs a NetworkSegmentResponse.

public __construct(string $createdAt, string $createdBy, bool $enabled, array<int, string> $filterIds, string $id, NetworkSegmentKind $kind, string $name, string $path, string $siteKey, string $tenantId, string $updatedAt, string $updatedBy, int $version, int $vlanId[, int|null $rank = null ]) : mixed
Parameters
$createdAt : string

Creation time.

$createdBy : string

The administrator who created it.

$enabled : bool

Whether the segment is a placement candidate.

$filterIds : array<int, string>

The Filter-Id names the segment's profile may choose from.

$id : string

The segment id; also the id of its resource node, which check_access is asked about, and of its reply profile.

$kind : NetworkSegmentKind

access (under /network/zones) or quarantine (under /network/quarantine); fixed for the segment's life.

$name : string

The segment's name, unique within its site.

$path : string

The segment's place in the reserved subtree, /network/{zones|quarantine}/<site_key>/<name>.

$siteKey : string

The site key.

$tenantId : string

The owning tenant.

$updatedAt : string

Last write time.

$updatedBy : string

The administrator who last wrote it.

$version : int

The version the next replace or delete must name.

$vlanId : int

The VLAN the tunnel attributes carry (1 to 4094), unique per site.

$rank : int|null = null

The placement rank among a site's access segments (lowest wins); absent for a quarantine segment. (optional)

fromArray()

Rebuilds a NetworkSegmentResponse from one decoded JSON object.

public static fromArray(array<string, mixed> $data) : self
Parameters
$data : array<string, mixed>

The raw wire object.

Return values
self

jsonSerialize()

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).

Rendering for a log line never fails: an unknown union arm renders its discriminator and an unrecognised enum value its empty Unknown spelling here, and only self::toArray() -- the request path -- refuses to send it (CONTRACT.md §31.2, §34.2 P12.2).

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.

Return values
array<string, mixed>

unknownEnumValue()

The string the server sent for an open-enum member this SDK has no name for, or `null`.

public unknownEnumValue(string $wire) : string|null

Only a model decoded by self::fromArray() knows it, and only for a member that decoded to Unknown (CONTRACT.md §27.6.2 item 4, §34.8 (c)): it lets a refusal name the value. It is for messages -- it is never rendered by self::toArray() or self::jsonSerialize() and so is never sent.

Parameters
$wire : string

The member's wire name.

Return values
string|null
On this page

Search results