AXIAM PHP SDK

CreateNetworkSegmentRequest
in package
implements JsonSerializable

FinalYes

The body of `POST /api/v1/network/segments`.

Table of Contents

Interfaces

JsonSerializable

Properties

$enabled  : bool|null
$filterIds  : array<string|int, mixed>|null
$kind  : NetworkSegmentKind
$name  : string
$rank  : int|null
$siteKey  : string
$vlanId  : int

Methods

__construct()  : mixed
Constructs a CreateNetworkSegmentRequest.
fromArray()  : self
Rebuilds a CreateNetworkSegmentRequest 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 CreateNetworkSegmentRequest.

public __construct(NetworkSegmentKind $kind, string $name, string $siteKey, int $vlanId[, bool|null $enabled = null ][, array<int, string>|null $filterIds = null ][, int|null $rank = null ]) : mixed
Parameters
$kind : NetworkSegmentKind

access or quarantine. Decides the branch the segment lives under.

$name : string

The segment's name, same pattern, unique within the site.

$siteKey : string

The site key (^[A-Za-z0-9][A-Za-z0-9._-]{0,62}$). A single-site tenant uses default.

$vlanId : int

The VLAN (1 to 4094), unique within the site.

$enabled : bool|null = null

Whether the segment starts as a placement candidate. Defaults to true. (optional)

$filterIds : array<int, string>|null = null

The Filter-Id names the segment's profile may choose from: its envelope. At most 32, each matching the pattern above. (optional)

$rank : int|null = null

The placement rank (unique within the site): required for access, absent for quarantine. (optional)

fromArray()

Rebuilds a CreateNetworkSegmentRequest 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