CancellationRequest
in package
FinalYes
Server-owned request identity, deadline and opaque history refresh location.
Table of Contents
Properties
- $cleanupDeadlineAt : string
- $context : CancellationContext|null
- $historyRefreshPageToken : string|null
- $requestedAt : string
- $requestId : string
Methods
- fromHistoryPayload() : self
- fromObservation() : self
- withHistoryRefreshPageToken() : self
- Preserve the canonical snapshot while retaining the observed refresh route.
- __construct() : mixed
- text() : string
- timestamp() : DateTimeImmutable
- validated() : self
Properties
$cleanupDeadlineAt read-only
public
string
$cleanupDeadlineAt
$context read-only
public
CancellationContext|null
$context
= null
$historyRefreshPageToken read-only
public
string|null
$historyRefreshPageToken
$requestedAt read-only
public
string
$requestedAt
$requestId read-only
public
string
$requestId
Methods
fromHistoryPayload()
public
static fromHistoryPayload(array<string, mixed> $payload, string $recordedAt) : self
Parameters
- $payload : array<string, mixed>
- $recordedAt : string
Return values
selffromObservation()
public
static fromObservation(array<string, mixed> $value) : self
Parameters
- $value : array<string, mixed>
Return values
selfwithHistoryRefreshPageToken()
Preserve the canonical snapshot while retaining the observed refresh route.
public
withHistoryRefreshPageToken(string|null $pageToken) : self
Parameters
- $pageToken : string|null
Return values
self__construct()
private
__construct(string $requestId, string $requestedAt, string $cleanupDeadlineAt, string|null $historyRefreshPageToken[, CancellationContext|null $context = null ]) : mixed
Parameters
- $requestId : string
- $requestedAt : string
- $cleanupDeadlineAt : string
- $historyRefreshPageToken : string|null
- $context : CancellationContext|null = null
text()
private
static text(array<string, mixed> $value, string $key) : string
Parameters
- $value : array<string, mixed>
- $key : string
Return values
stringtimestamp()
private
static timestamp(string $value) : DateTimeImmutable
Parameters
- $value : string
Return values
DateTimeImmutablevalidated()
private
static validated(string $requestId, string $requestedAt, string $cleanupDeadlineAt, string|null $historyRefreshPageToken[, CancellationContext|null $context = null ]) : self
Parameters
- $requestId : string
- $requestedAt : string
- $cleanupDeadlineAt : string
- $historyRefreshPageToken : string|null
- $context : CancellationContext|null = null