AXIAM PHP SDK

CreateReactorRequest
in package
implements JsonSerializable

FinalYes

The `CreateReactorRequest` schema from the server's OpenAPI document.

Table of Contents

Interfaces

JsonSerializable

Properties

$description  : string|null
$enabled  : bool|null
$events  : array<string|int, mixed>
$failurePolicy  : FailurePolicy|null
$mode  : ReactorMode
$name  : string
$priority  : int|null
$timeoutMs  : int|null

Methods

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

public __construct(array<int, string> $events, ReactorMode $mode, string $name[, string|null $description = null ][, bool|null $enabled = null ][, FailurePolicy|null $failurePolicy = null ][, int|null $priority = null ][, int|null $timeoutMs = null ]) : mixed
Parameters
$events : array<int, string>

Event names from the registry (GET /api/v1/reactors/events).

$mode : ReactorMode

the server's mode field

$name : string

the server's name field

$description : string|null = null

the server's description field (optional)

$enabled : bool|null = null

the server's enabled field (optional)

$failurePolicy : FailurePolicy|null = null

the server's failure_policy field (optional)

$priority : int|null = null

the server's priority field (optional)

$timeoutMs : int|null = null

Omit to take the 500 ms default. Capped at 5 000 ms. (optional)

fromArray()

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