CreatePgpKeyRequest
in package
implements
JsonSerializable
The `CreatePgpKeyRequest` schema from the server's OpenAPI document.
Table of Contents
Interfaces
- JsonSerializable
Properties
- $algorithm : PgpKeyAlgorithm
- $email : string
- $name : string
- $purpose : PgpKeyPurpose
Methods
- __construct() : mixed
- Constructs a CreatePgpKeyRequest.
- fromArray() : self
- Rebuilds a CreatePgpKeyRequest 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
$algorithm read-only
public
PgpKeyAlgorithm
$algorithm
$email read-only
public
string
$email
$name read-only
public
string
$name
$purpose read-only
public
PgpKeyPurpose
$purpose
Methods
__construct()
Constructs a CreatePgpKeyRequest.
public
__construct(PgpKeyAlgorithm $algorithm, string $email, string $name, PgpKeyPurpose $purpose) : mixed
Parameters
- $algorithm : PgpKeyAlgorithm
-
the server's
algorithmfield - $email : string
-
Email for the OpenPGP User ID.
- $name : string
-
the server's
namefield - $purpose : PgpKeyPurpose
-
the server's
purposefield
fromArray()
Rebuilds a CreatePgpKeyRequest 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.