AXIAM PHP SDK

NetworkPolicyResponse
in package
implements JsonSerializable

FinalYes

The tenant's network policy, as the management API returns it.

Table of Contents

Interfaces

JsonSerializable

Properties

$sessionTimeoutMaxSecs  : int
$tenantId  : string
$updatedAt  : string|null
$updatedBy  : string|null
$version  : int

Methods

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

Methods

__construct()

Constructs a NetworkPolicyResponse.

public __construct(int $sessionTimeoutMaxSecs, string $tenantId, int $version[, string|null $updatedAt = null ][, string|null $updatedBy = null ]) : mixed
Parameters
$sessionTimeoutMaxSecs : int

network.session_timeout_max_secs: the most a reply profile's Session-Timeout may be, in seconds (300 to 86 400; 3600 until the tenant writes one). A stored profile above it is clamped at read.

$tenantId : string

The owning tenant.

$version : int

The version the next PUT must name; 0 until the tenant first writes.

$updatedAt : string|null = null

Last write time; absent while it is the default. (optional)

$updatedBy : string|null = null

The administrator who last wrote it; absent while it is the default. (optional)

fromArray()

Rebuilds a NetworkPolicyResponse 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).

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>
On this page

Search results