RotateSecretResponse
in package
implements
JsonSerializable
FinalYes
Response for secret rotation.
Table of Contents
Interfaces
- JsonSerializable
Properties
Methods
- __construct() : mixed
- Constructs a RotateSecretResponse.
- fromArray() : self
- Rebuilds a RotateSecretResponse 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
$clientSecret read-only
public
Sensitive
$clientSecret
Methods
__construct()
Constructs a RotateSecretResponse.
public
__construct(Sensitive $clientSecret) : mixed
Parameters
- $clientSecret : Sensitive
-
the server's
client_secretfield — a one-time secret (§27.5)
fromArray()
Rebuilds a RotateSecretResponse 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.