AXIAM PHP SDK

SsfStreamInput
in package
implements JsonSerializable

FinalYes

`create_stream` and `update_stream` (a **replacement**) body.

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. Left unset, the write-only secret (authorization_header) is not reset but kept -- see the operation's documentation for when a write must carry it.

Table of Contents

Interfaces

JsonSerializable

Properties

$audience  : string
$authorizationHeader  : Sensitive|null
$clearAuthorizationHeader  : bool|null
$deliveryMethod  : SsfDeliveryMethod
$description  : string|null
$endpointUrl  : string|null
$eventsAllowed  : array<string|int, mixed>
$eventsRequested  : array<string|int, mixed>|null
$expectedUpdatedAt  : string|null
$receiverClientId  : string
$status  : SsfStreamStatus|null
$statusReason  : string|null
$subjectFormat  : SsfSubjectFormat|null

Methods

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

$clearAuthorizationHeader read-only

public bool|null $clearAuthorizationHeader = null

$eventsAllowed read-only

public array<string|int, mixed> $eventsAllowed

$eventsRequested read-only

public array<string|int, mixed>|null $eventsRequested = null

$expectedUpdatedAt read-only

public string|null $expectedUpdatedAt = null

Methods

__construct()

Constructs a SsfStreamInput.

public __construct(string $audience, SsfDeliveryMethod $deliveryMethod, array<int, SsfEventType|string> $eventsAllowed, string $receiverClientId[, Sensitive|null $authorizationHeader = null ][, bool|null $clearAuthorizationHeader = null ][, string|null $description = null ][, string|null $endpointUrl = null ][, array<int, SsfEventType|string>|null $eventsRequested = null ][, string|null $expectedUpdatedAt = null ][, SsfStreamStatus|null $status = null ][, string|null $statusReason = null ][, SsfSubjectFormat|null $subjectFormat = null ]) : mixed
Parameters
$audience : string

1–512 bytes; unique across the deployment.

$deliveryMethod : SsfDeliveryMethod

push or poll.

$eventsAllowed : array<int, SsfEventType|string>

1–6 event types.

$receiverClientId : string

An OAuth2 client of the tenant with the client_credentials grant and the ssf.manage scope.

$authorizationHeader : Sensitive|null = null

Write-only. The Authorization header value AXIAM sends to a push endpoint. On update, absent keeps the stored one — except that moving the endpoint to another origin requires it again. (optional)

$clearAuthorizationHeader : bool|null = null

On update: remove the stored header. Refused together with authorization_header. (optional)

$description : string|null = null

At most 256 bytes. (optional)

$endpointUrl : string|null = null

Required for push (an https URL under the outbound address policy), refused for poll. (optional)

$eventsRequested : array<int, SsfEventType|string>|null = null

A subset of events_allowed; absent means all of them. The receiver may narrow it later, never widen it. On update, absent therefore resets a narrowing the receiver made to every allowed event, and [] keeps a receiver's "none": a client that edits a stream sends the value it read (cut to the new events_allowed), never an absent field. (optional)

$expectedUpdatedAt : string|null = null

The updated_at of the stream as the client read it (R1W2-03, T-406). Update only; create ignores it. When present, the replacement lands only if the stream still has that version, else 409 (reload and retry): a pause or a narrowing the receiver made after the form was read is not silently reverted. When absent the replacement is conditional on the version the server reads during the request — an old client keeps that behaviour, and the console always sends it. (optional)

$status : SsfStreamStatus|null = null

enabled by default. (optional)

$statusReason : string|null = null

At most 256 bytes. (optional)

$subjectFormat : SsfSubjectFormat|null = null

iss_sub by default. (optional)

fromArray()

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