Skip to main content

Class: Capabilities

Namespace capability details. Should contain what features are enabled in a namespace.

Properties​

asyncUpdate​

asyncUpdate: boolean

True if the namespace supports async update

eagerWorkflowStart​

eagerWorkflowStart: boolean

True if the namespace supports eager workflow start.

pollerAutoscaling​

pollerAutoscaling: boolean

True if the namespace supports poller autoscaling

pollerAutoscalingAutoEnroll​

pollerAutoscalingAutoEnroll: boolean

When true, workers should use poller autoscaling by default unless explicitly configured otherwise.

reportedProblemsSearchAttribute​

reportedProblemsSearchAttribute: boolean

True if the namespace supports reported problems search attribute

standaloneActivities​

standaloneActivities: boolean

True if the namespace supports standalone activities

standaloneActivityBatchOperations​

standaloneActivityBatchOperations: boolean

True if the namespace supports batch operations for standalone activities.

standaloneActivityOperatorCommands​

standaloneActivityOperatorCommands: boolean

True if the namespace supports standalone activity operator commands.

standaloneActivityStartDelay​

standaloneActivityStartDelay: boolean

True if the namespace supports start delay for standalone activities.

standaloneNexusOperation​

standaloneNexusOperation: boolean

True if the namespace supports standalone Nexus operations.

syncUpdate​

syncUpdate: boolean

True if the namespace supports sync update

workerCommands​

workerCommands: boolean

True if the namespace supports worker commands (server-to-worker communication via control queues).

workerHeartbeats​

workerHeartbeats: boolean

True if the namespace supports worker heartbeats

workerPollCompleteOnShutdown​

workerPollCompleteOnShutdown: boolean

True if the namespace supports server-side completion of outstanding worker polls on shutdown. When enabled, the server will complete polls for workers that send WorkerInstanceKey in their poll requests and call ShutdownWorker with the same WorkerInstanceKey. The poll will return an empty response. When this flag is true, workers should allow polls to return gracefully rather than terminating any open polls on shutdown.

workflowPause​

workflowPause: boolean

True if the namespace supports pausing workflows

workflowTaskCompletionPagination​

workflowTaskCompletionPagination: boolean

True if the namespace supports pagination of RespondWorkflowTaskCompleted request.

workflowUpdateCallbacks​

workflowUpdateCallbacks: boolean

True if the namespace supports attaching callbacks on workflow updates

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.namespace.v1.NamespaceInfo.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.namespace.v1.NamespaceInfo.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