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>
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
Methods
__construct()
Constructs a CreateNotificationRuleRequest.
public
__construct(string $description, array<int, NotificationEventType> $events, string $name, array<int, string> $recipientEmails) : 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.
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).
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.