Class: Capabilities

System capability details.

Properties

activityFailureIncludeHeartbeat

activityFailureIncludeHeartbeat: boolean

True if RespondActivityTaskFailed API supports including heartbeat details

---

buildIdBasedVersioning

buildIdBasedVersioning: boolean

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

countGroupByExecutionStatus: boolean

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

---

eagerWorkflowStart

eagerWorkflowStart: boolean

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

---

encodedFailureAttributes

encodedFailureAttributes: boolean

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

---

internalErrorDifferentiation

internalErrorDifferentiation: boolean

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

nexus: boolean

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

sdkMetadata: boolean

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

---

serverScaledDeployments

serverScaledDeployments: boolean

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

serverScaledProviderCloudRun: boolean

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

signalAndQueryHeader: boolean

True if signal and query headers are supported.

---

supportsSchedules

supportsSchedules: boolean

Supports scheduled workflow features.

---

upsertMemo

upsertMemo: boolean

True if server supports upserting workflow memo

Methods

toJSON()

toJSON(): object

Converts this Capabilities to JSON.

Returns

object

JSON object

---

create()

Call Signature

static create(properties?): Capabilities & $Properties

Creates a new Capabilities instance using the specified properties.

Parameters

properties?

$Properties

Properties to set

Returns

Capabilities & $Properties

Capabilities instance

Call Signature

static create(properties?): Capabilities

Creates a new Capabilities instance using the specified properties.

Parameters

properties?

$Properties

Properties to set

Returns

Capabilities

Capabilities instance

---

decode()

static decode(reader, length?): Capabilities & $Properties

Decodes a Capabilities message from the specified reader or buffer.

Parameters

reader

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

length?

number

Message length if known beforehand

Returns

Capabilities & $Properties

Capabilities

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited()

static decodeDelimited(reader): Capabilities & $Properties

Decodes a Capabilities message from the specified reader or buffer, length delimited.

Parameters

reader

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns

Capabilities & $Properties

Capabilities

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

encode()

static encode(message, writer?): Writer

Encodes the specified Capabilities message. Does not implicitly temporal.api.workflowservice.v1.GetSystemInfoResponse.Capabilities.verify|verify messages.

Parameters

message

$Properties

Capabilities message or plain object to encode

writer?

Writer

Writer to encode to

Returns

Writer

Writer

---

encodeDelimited()

static encodeDelimited(message, writer?): Writer

Encodes the specified Capabilities message, length delimited. Does not implicitly temporal.api.workflowservice.v1.GetSystemInfoResponse.Capabilities.verify|verify messages.

Parameters

message

$Properties

Capabilities message or plain object to encode

writer?

Writer

Writer to encode to

Returns

Writer

Writer

---

fromObject()

static fromObject(object): Capabilities

Creates a Capabilities message from a plain object. Also converts values to their respective internal types.

Parameters

object

Plain object

Returns

Capabilities

Capabilities

---

toObject()

static toObject(message, options?): object

Creates a plain object from a Capabilities message. Also converts values to other types if specified.

Parameters

message

Capabilities

Capabilities

options?

IConversionOptions

Conversion options

Returns

object

Plain object