WorkflowStreamDescription
in package
FinalYes
Lifecycle and backlog metadata for one run-scoped Workflow Stream.
Table of Contents
Properties
- $closedAt : string|null
- $errorReason : string|null
- $lastAppendedAt : string|null
- $lastOffset : int
- $openedAt : string|null
- $pendingItems : int
- $raw : array<string|int, mixed>
- $retentionSeconds : int|null
- $status : string
- $streamName : string
- $totalItems : int
Methods
- __construct() : mixed
- fromArray() : self
- isTerminal() : bool
Properties
$closedAt read-only
public
string|null
$closedAt
$errorReason read-only
public
string|null
$errorReason
$lastAppendedAt read-only
public
string|null
$lastAppendedAt
$lastOffset read-only
public
int
$lastOffset
$openedAt read-only
public
string|null
$openedAt
$pendingItems read-only
public
int
$pendingItems
$raw read-only
public
array<string|int, mixed>
$raw
$retentionSeconds read-only
public
int|null
$retentionSeconds
$status read-only
public
string
$status
$streamName read-only
public
string
$streamName
$totalItems read-only
public
int
$totalItems
Methods
__construct()
public
__construct(string $streamName, string $status, int $lastOffset, int $totalItems, int $pendingItems, string|null $openedAt, string|null $lastAppendedAt, string|null $closedAt, string|null $errorReason, int|null $retentionSeconds, array<string, mixed> $raw) : mixed
Parameters
- $streamName : string
- $status : string
- $lastOffset : int
- $totalItems : int
- $pendingItems : int
- $openedAt : string|null
- $lastAppendedAt : string|null
- $closedAt : string|null
- $errorReason : string|null
- $retentionSeconds : int|null
- $raw : array<string, mixed>
fromArray()
public
static fromArray(array<string, mixed> $value) : self
Parameters
- $value : array<string, mixed>
Return values
selfisTerminal()
public
isTerminal() : bool