Documentation

ServerCapabilities
in package

FinalYes
Tags
see
Capabilities

Table of Contents

Properties

$activityFailureIncludeHeartbeat  : bool
$buildIdBasedVersioning  : bool
$countGroupByExecutionStatus  : bool
$eagerWorkflowStart  : bool
$encodedFailureAttributes  : bool
$internalErrorDifferentiation  : bool
$sdkMetadata  : bool
$signalAndQueryHeader  : bool
$supportsSchedules  : bool
$upsertMemo  : bool

Methods

__construct()  : mixed
isInternalErrorDifferentiation()  : bool
True if internal errors are differentiated from other types of errors for purposes of retrying non-internal errors.
isSignalAndQueryHeaderSupports()  : bool
True if signal and query headers are supported.

Properties

$activityFailureIncludeHeartbeat read-only

public bool $activityFailureIncludeHeartbeat = false

$countGroupByExecutionStatus read-only

public bool $countGroupByExecutionStatus = false

$encodedFailureAttributes read-only

public bool $encodedFailureAttributes = false

$internalErrorDifferentiation read-only

public bool $internalErrorDifferentiation = false

Methods

__construct()

public __construct([bool $signalAndQueryHeader = false ][, bool $internalErrorDifferentiation = false ][, bool $activityFailureIncludeHeartbeat = false ][, bool $supportsSchedules = false ][, bool $encodedFailureAttributes = false ][, bool $buildIdBasedVersioning = false ][, bool $upsertMemo = false ][, bool $eagerWorkflowStart = false ][, bool $sdkMetadata = false ][, bool $countGroupByExecutionStatus = false ]) : mixed
Parameters
$signalAndQueryHeader : bool = false

True if signal and query headers are supported.

$internalErrorDifferentiation : bool = false

True if internal errors are differentiated from other types of errors for purposes of retrying non-internal errors. When unset/false, clients retry all failures. When true, clients should only retry non-internal errors.

$activityFailureIncludeHeartbeat : bool = false

True if RespondActivityTaskFailed API supports including heartbeat details

$supportsSchedules : bool = false

Supports scheduled workflow features.

$encodedFailureAttributes : bool = false

True if server uses protos that include temporal.api.failure.v1.Failure.encoded_attributes

$buildIdBasedVersioning : bool = false

True if server supports dispatching Workflow and Activity tasks based on a worker's build_id (see: https://github.com/temporalio/proposals/blob/a123af3b559f43db16ea6dd31870bfb754c4dc5e/versioning/worker-versions.md)

$upsertMemo : bool = false

True if server supports upserting workflow memo

$eagerWorkflowStart : bool = false

True if server supports eager workflow task dispatching for the StartWorkflowExecution API

$sdkMetadata : bool = false

True if the server knows about the sdk metadata field on WFT completions and will record it in history

$countGroupByExecutionStatus : bool = false

True if the server supports count group by execution status (-- api-linter: core::0140::prepositions=disabled --)

isInternalErrorDifferentiation()

True if internal errors are differentiated from other types of errors for purposes of retrying non-internal errors.

public isInternalErrorDifferentiation() : bool

When unset/false, clients retry all failures. When true, clients should only retry non-internal errors.

Tags
deprecated

Use self::$internalErrorDifferentiation instead.

Return values
bool

isSignalAndQueryHeaderSupports()

True if signal and query headers are supported.

public isSignalAndQueryHeaderSupports() : bool
Tags
deprecated

Use self::$signalAndQueryHeader instead.

Return values
bool

        
On this page

Search results