Class: Capabilities

v1.GetSystemInfoResponse.Capabilities

System capability details.

Implements

• ICapabilities

Constructors

constructor

• new Capabilities(properties?): Capabilities

Constructs a new Capabilities.

Parameters

Name	Type	Description
properties?	ICapabilities	Properties to set

Returns

Capabilities

Properties

activityFailureIncludeHeartbeat

• activityFailureIncludeHeartbeat: boolean

True if RespondActivityTaskFailed API supports including heartbeat details

Implementation of

ICapabilities.activityFailureIncludeHeartbeat

---

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)

Implementation of

ICapabilities.buildIdBasedVersioning

---

countGroupByExecutionStatus

• countGroupByExecutionStatus: boolean

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

Implementation of

ICapabilities.countGroupByExecutionStatus

---

eagerWorkflowStart

• eagerWorkflowStart: boolean

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

Implementation of

ICapabilities.eagerWorkflowStart

---

encodedFailureAttributes

• encodedFailureAttributes: boolean

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

Implementation of

ICapabilities.encodedFailureAttributes

---

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.

Implementation of

ICapabilities.internalErrorDifferentiation

---

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.

Implementation of

ICapabilities.nexus

---

sdkMetadata

• sdkMetadata: boolean

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

Implementation of

ICapabilities.sdkMetadata

---

signalAndQueryHeader

• signalAndQueryHeader: boolean

True if signal and query headers are supported.

Implementation of

ICapabilities.signalAndQueryHeader

---

supportsSchedules

• supportsSchedules: boolean

Supports scheduled workflow features.

Implementation of

ICapabilities.supportsSchedules

---

upsertMemo

• upsertMemo: boolean

True if server supports upserting workflow memo

Implementation of

ICapabilities.upsertMemo

Methods

toJSON

▸ toJSON(): Object

Converts this Capabilities to JSON.

Returns

Object

JSON object

---

create

▸ create(properties?): Capabilities

Creates a new Capabilities instance using the specified properties.

Parameters

Name	Type	Description
properties?	ICapabilities	Properties to set

Returns

Capabilities

Capabilities instance

---

decode

▸ decode(reader, length?): Capabilities

Decodes a Capabilities message from the specified reader or buffer.

Parameters

Name	Type	Description
reader	Uint8Array | Reader	Reader or buffer to decode from
length?	number	Message length if known beforehand

Returns

Capabilities

Capabilities

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited

▸ decodeDelimited(reader): Capabilities

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

Parameters

Name	Type	Description
reader	Uint8Array | Reader	Reader or buffer to decode from

Returns

Capabilities

Capabilities

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

encode

▸ encode(message, writer?): Writer

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

Parameters

Name	Type	Description
message	ICapabilities	Capabilities message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

encodeDelimited

▸ encodeDelimited(message, writer?): Writer

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

Parameters

Name	Type	Description
message	ICapabilities	Capabilities message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

fromObject

▸ fromObject(object): Capabilities

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

Parameters

Name	Type	Description
object	Object	Plain object

Returns

Capabilities

Capabilities

---

getTypeUrl

▸ getTypeUrl(typeUrlPrefix?): string

Gets the default type url for Capabilities

Parameters

Name	Type	Description
typeUrlPrefix?	string	your custom typeUrlPrefix(default "type.googleapis.com")

Returns

string

The default type url

---

toObject

▸ toObject(message, options?): Object

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

Parameters

Name	Type	Description
message	Capabilities	Capabilities
options?	IConversionOptions	Conversion options

Returns

Object

Plain object