Skip to main content

Interface: $Properties

Properties of a Capabilities.

Extended by​

Properties​

activityFailureIncludeHeartbeat?​

optional activityFailureIncludeHeartbeat?: boolean | null

True if RespondActivityTaskFailed API supports including heartbeat details

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)

countGroupByExecutionStatus?​

optional countGroupByExecutionStatus?: boolean | null

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

eagerWorkflowStart?​

optional eagerWorkflowStart?: boolean | null

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

encodedFailureAttributes?​

optional encodedFailureAttributes?: boolean | null

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

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.

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.

sdkMetadata?​

optional sdkMetadata?: boolean | null

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

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.

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.

signalAndQueryHeader?​

optional signalAndQueryHeader?: boolean | null

True if signal and query headers are supported.

supportsSchedules?​

optional supportsSchedules?: boolean | null

Supports scheduled workflow features.

upsertMemo?​

optional upsertMemo?: boolean | null

True if server supports upserting workflow memo