Durable Workflow PHP SDK — API Reference

Guides

ClusterInfo
in package

FinalYes

Public compatibility and capability manifest returned by cluster discovery.

Table of Contents

Constants

COMMAND_REQUEST_KEYS  : mixed = 'command_request_keys'
Signal and update `request_id` is a durable command key (native Server 3.9.0 and later).
TASK_QUEUE_ACTIVITY_DISPATCH_PAUSE  : mixed = 'task_queue_activity_dispatch_pause'
Per-task-queue activity dispatch pause and resume (native Server 3.8.0 and later).

Properties

$capabilities  : array<string|int, mixed>
$controlPlane  : array<string|int, mixed>
$defaultNamespace  : string|null
$limits  : array<string|int, mixed>
$namespace  : array<string|int, mixed>
$raw  : array<string|int, mixed>
$serverId  : string|null
$version  : string|null

Methods

__construct()  : mixed
fromArray()  : self
supportsCommandRequestKeys()  : bool
Whether a signal or update `request_id` is a durable command key on the workflow instance.
supportsTaskQueueActivityDispatchPause()  : bool
Whether the Server can pause and resume activity dispatch on a task queue. A Server that doesn't advertise it has no pause routes, so check it before offering a pause.
map()  : array<string, mixed>

Constants

COMMAND_REQUEST_KEYS

Signal and update `request_id` is a durable command key (native Server 3.9.0 and later).

public mixed COMMAND_REQUEST_KEYS = 'command_request_keys'

TASK_QUEUE_ACTIVITY_DISPATCH_PAUSE

Per-task-queue activity dispatch pause and resume (native Server 3.8.0 and later).

public mixed TASK_QUEUE_ACTIVITY_DISPATCH_PAUSE = 'task_queue_activity_dispatch_pause'

Properties

$capabilities read-only

public array<string|int, mixed> $capabilities

$controlPlane read-only

public array<string|int, mixed> $controlPlane

$defaultNamespace read-only

public string|null $defaultNamespace

$limits read-only

public array<string|int, mixed> $limits

$namespace read-only

public array<string|int, mixed> $namespace

Methods

__construct()

public __construct(string|null $serverId, string|null $version, string|null $defaultNamespace, array<string, mixed> $namespace, array<string, mixed> $capabilities, array<string, mixed> $limits, array<string, mixed> $controlPlane, array<string, mixed> $raw) : mixed
Parameters
$serverId : string|null
$version : string|null
$defaultNamespace : string|null
$namespace : array<string, mixed>
$capabilities : array<string, mixed>
$limits : array<string, mixed>
$controlPlane : array<string, mixed>
$raw : array<string, mixed>

fromArray()

public static fromArray(array<string, mixed> $value) : self
Parameters
$value : array<string, mixed>
Return values
self

supportsCommandRequestKeys()

Whether a signal or update `request_id` is a durable command key on the workflow instance.

public supportsCommandRequestKeys() : bool

When true, a retry with the same name, arguments and run target returns the original receipt, and the same key with different input is refused with 409 request_id_conflict. Without it, a repeated signal key can record a second signal and a changed update reuses the original receipt, so keep business-event handling idempotent.

Return values
bool

supportsTaskQueueActivityDispatchPause()

Whether the Server can pause and resume activity dispatch on a task queue. A Server that doesn't advertise it has no pause routes, so check it before offering a pause.

public supportsTaskQueueActivityDispatchPause() : bool
Return values
bool

map()

private static map(mixed $value) : array<string, mixed>
Parameters
$value : mixed
Return values
array<string, mixed>
On this page

Search results