CreateNotificationRuleRequest
in package
implements
JsonSerializable
The `CreateNotificationRuleRequest` schema from the server's OpenAPI document.
Table of Contents
Interfaces
- JsonSerializable
Properties
- $description : string
- $events : array<string|int, mixed>
- $name : string
- $recipientEmails : array<string|int, mixed>
- $windowMinutes : int|null
Methods
- __construct() : mixed
- Constructs a CreateNotificationRuleRequest.
- fromArray() : self
- Rebuilds a CreateNotificationRuleRequest 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
$description read-only
public
string
$description
$events read-only
public
array<string|int, mixed>
$events
$name read-only
public
string
$name
$recipientEmails read-only
public
array<string|int, mixed>
$recipientEmails
$windowMinutes read-only
public
int|null
$windowMinutes
= null
Methods
__construct()
Constructs a CreateNotificationRuleRequest.
public
__construct(string $description, array<int, NotificationEventType> $events, string $name, array<int, string> $recipientEmails[, int|null $windowMinutes = null ]) : mixed
Parameters
- $description : string
-
Description of what this rule monitors.
- $events : array<int, NotificationEventType>
-
Event types that trigger this rule.
- $name : string
-
Human-readable name for the rule.
- $recipientEmails : array<int, string>
-
Email addresses to notify.
- $windowMinutes : int|null = null
-
Minutes in which one event type mails each recipient at most once: the first event of a window is mailed, the rest are counted and the next mail says how many were not sent (#551). 1 … 1440; 15 when omitted. (optional)
fromArray()
Rebuilds a CreateNotificationRuleRequest from one decoded JSON object.
public
static fromArray(array<string, mixed> $data) : self
Parameters
- $data : array<string, mixed>
-
The raw wire object.
Return values
selfjsonSerialize()
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.