Skip to main content

Interface: ICapabilities

Properties of a Capabilities.

Extends​

Properties​

activityFailureIncludeHeartbeat?​

optional activityFailureIncludeHeartbeat?: boolean | null

True if RespondActivityTaskFailed API supports including heartbeat details

Inherited from​

$Properties.activityFailureIncludeHeartbeat

buildIdBasedVersioning?​

optional buildIdBasedVersioning?: boolean | null

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)

Inherited from​

$Properties.buildIdBasedVersioning

countGroupByExecutionStatus?​

optional countGroupByExecutionStatus?: boolean | null

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

Inherited from​

$Properties.countGroupByExecutionStatus

eagerWorkflowStart?​

optional eagerWorkflowStart?: boolean | null

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

Inherited from​

$Properties.eagerWorkflowStart

encodedFailureAttributes?​

optional encodedFailureAttributes?: boolean | null

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

Inherited from​

$Properties.encodedFailureAttributes

internalErrorDifferentiation?​

optional internalErrorDifferentiation?: boolean | null

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.

Inherited from​

$Properties.internalErrorDifferentiation

nexus?​

optional nexus?: boolean | null

True if the server supports Nexus operations. This flag is dependent both on server version and for Nexus to be enabled via server configuration.

Inherited from​

$Properties.nexus

sdkMetadata?​

optional sdkMetadata?: boolean | null

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

Inherited from​

$Properties.sdkMetadata

serverScaledDeployments?​

optional serverScaledDeployments?: boolean | null

True if the server supports server-scaled deployments. This flag is dependent both on server version and for server-scaled deployments to be enabled via server configuration.

Inherited from​

$Properties.serverScaledDeployments

serverScaledProviderCloudRun?​

optional serverScaledProviderCloudRun?: boolean | null

True if the server supports the Cloud Run compute provider for server-scaled deployments. Dependent on server version and the provider being enabled via server configuration.

Inherited from​

$Properties.serverScaledProviderCloudRun

signalAndQueryHeader?​

optional signalAndQueryHeader?: boolean | null

True if signal and query headers are supported.

Inherited from​

$Properties.signalAndQueryHeader

supportsSchedules?​

optional supportsSchedules?: boolean | null

Supports scheduled workflow features.

Inherited from​

$Properties.supportsSchedules

upsertMemo?​

optional upsertMemo?: boolean | null

True if server supports upserting workflow memo

Inherited from​

$Properties.upsertMemo