UpdateRole
in package
implements
JsonSerializable
The `UpdateRole` schema from the server's OpenAPI document.
Every property is optional, so this is a SPARSE body: what you leave unset is left unchanged, and is omitted from the wire request entirely rather than sent as null (§27.4 rule 5).
Table of Contents
Interfaces
- JsonSerializable
Properties
- $description : string|null
- $isGlobal : bool|null
- $name : string|null
Methods
- __construct() : mixed
- Constructs a UpdateRole.
- fromArray() : self
- Rebuilds a UpdateRole 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|null
$description
= null
$isGlobal read-only
public
bool|null
$isGlobal
= null
$name read-only
public
string|null
$name
= null
Methods
__construct()
Constructs a UpdateRole.
public
__construct([string|null $description = null ][, bool|null $isGlobal = null ][, string|null $name = null ]) : mixed
Parameters
- $description : string|null = null
-
the server's
descriptionfield (optional) - $isGlobal : bool|null = null
-
the server's
is_globalfield (optional) - $name : string|null = null
-
the server's
namefield (optional)
fromArray()
Rebuilds a UpdateRole 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.