SignalFailed
extends ServerException
in package
uses
CarriesCommandRequestId
A signal the Server refused, or whose request did not complete.
Table of Contents
Properties
- $details : array<string|int, mixed>|null
- $reason : string|null
- $status : int
- $requestId : string|null
Methods
- __construct() : mixed
- conflict() : array<int, string>
- The parts of the refused command that differ from the retained one, for a `request_id_conflict`: `name`, `arguments` or `target_or_arguments`. Otherwise empty.
- details() : array<string, mixed>
- The Server response fields, or an empty array when no envelope arrived.
- isActivityCompletionPayloadDiscoveryUnavailable() : bool
- Discovery failed before any activity-completion request was submitted.
- isActivityTaskBackendUnavailable() : bool
- A backend failure whose activity completion can be retried with the same attempt and lease.
- isRequestIdConflict() : bool
- Whether the Server retained a command with a different intent under the same key.
- isStorageAdmissionFailure() : bool
- Whether the Server explicitly refused admission and requested a same-identity retry.
- isTransientConnectionFailure() : bool
- isTransientUpstreamFailure() : bool
- A temporary upstream HTTP failure without a Server protocol envelope.
- isWorkflowTaskBackendUnavailable() : bool
- A backend failure whose workflow-task mutation can be retried with the same lease fence.
- isWorkflowTaskCompletionDeferred() : bool
- A completion explicitly deferred before commit, under the original lease.
- isWorkflowTaskCompletionPublicationDeferred() : bool
- A committed completion whose publication needs same-fence reconciliation.
- reason() : string|null
- The Server refusal reason, or null when no protocol envelope arrived.
- requestId() : string|null
- The `request_id` sent with the command, or null when it was not recorded.
- retainedCommandId() : string|null
- The command id retained under the key, for a `request_id_conflict`. Otherwise null.
Properties
$details read-only
public
array<string|int, mixed>|null
$details
= null
$reason read-only
public
string|null
$reason
= null
$status read-only
public
int
$status
$requestId read-only
private
string|null
$requestId
Methods
__construct()
public
__construct(string $message, int $status[, string|null $reason = null ][, array<string, mixed>|array<int, mixed>|null $details = null ][, Throwable|null $previous = null ][, string|null $requestId = null ]) : mixed
Parameters
- $message : string
- $status : int
- $reason : string|null = null
- $details : array<string, mixed>|array<int, mixed>|null = null
- $previous : Throwable|null = null
- $requestId : string|null = null
conflict()
The parts of the refused command that differ from the retained one, for a `request_id_conflict`: `name`, `arguments` or `target_or_arguments`. Otherwise empty.
public
conflict() : array<int, string>
Return values
array<int, string>details()
The Server response fields, or an empty array when no envelope arrived.
public
details() : array<string, mixed>
A request_id_conflict refusal carries outcome (rejected_request_id_conflict),
retained_command_id, retained_outcome and the mismatched conflict parts. Read
them with conflict() and retainedCommandId().
Return values
array<string, mixed>isActivityCompletionPayloadDiscoveryUnavailable()
Discovery failed before any activity-completion request was submitted.
public
isActivityCompletionPayloadDiscoveryUnavailable(string $taskId, string $attemptId, string $leaseOwner) : bool
Parameters
- $taskId : string
- $attemptId : string
- $leaseOwner : string
Return values
boolisActivityTaskBackendUnavailable()
A backend failure whose activity completion can be retried with the same attempt and lease.
public
isActivityTaskBackendUnavailable(string $taskId, string $attemptId, string $leaseOwner) : bool
Parameters
- $taskId : string
- $attemptId : string
- $leaseOwner : string
Return values
boolisRequestIdConflict()
Whether the Server retained a command with a different intent under the same key.
public
isRequestIdConflict() : bool
Nothing was written and the key keeps its original receipt. Don't retry this unchanged: send the original input to recover the receipt, or use a new key for new input.
Return values
boolisStorageAdmissionFailure()
Whether the Server explicitly refused admission and requested a same-identity retry.
public
isStorageAdmissionFailure([string|null $pollRequestId = null ]) : bool
Parameters
- $pollRequestId : string|null = null
Return values
boolisTransientConnectionFailure()
public
isTransientConnectionFailure() : bool
Return values
boolisTransientUpstreamFailure()
A temporary upstream HTTP failure without a Server protocol envelope.
public
isTransientUpstreamFailure() : bool
Return values
boolisWorkflowTaskBackendUnavailable()
A backend failure whose workflow-task mutation can be retried with the same lease fence.
public
isWorkflowTaskBackendUnavailable(string $taskId, string $leaseOwner, int $attempt[, string $operation = 'heartbeat_workflow_task' ]) : bool
Parameters
- $taskId : string
- $leaseOwner : string
- $attempt : int
- $operation : string = 'heartbeat_workflow_task'
Return values
boolisWorkflowTaskCompletionDeferred()
A completion explicitly deferred before commit, under the original lease.
public
isWorkflowTaskCompletionDeferred(string $taskId, string $leaseOwner, int $attempt) : bool
Parameters
- $taskId : string
- $leaseOwner : string
- $attempt : int
Return values
boolisWorkflowTaskCompletionPublicationDeferred()
A committed completion whose publication needs same-fence reconciliation.
public
isWorkflowTaskCompletionPublicationDeferred(string $taskId, string $leaseOwner, int $attempt) : bool
Parameters
- $taskId : string
- $leaseOwner : string
- $attempt : int
Return values
boolreason()
The Server refusal reason, or null when no protocol envelope arrived.
public
reason() : string|null
Return values
string|nullrequestId()
The `request_id` sent with the command, or null when it was not recorded.
public
requestId() : string|null
Return values
string|nullretainedCommandId()
The command id retained under the key, for a `request_id_conflict`. Otherwise null.
public
retainedCommandId() : string|null