Class: Capabilities

v1.NamespaceInfo.Capabilities

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

Implements

• ICapabilities

Constructors

constructor

• new Capabilities(properties?): Capabilities

Constructs a new Capabilities.

Parameters

Name	Type	Description
properties?	ICapabilities	Properties to set

Returns

Capabilities

Properties

asyncUpdate

• asyncUpdate: boolean

True if the namespace supports async update

Implementation of

ICapabilities.asyncUpdate

---

eagerWorkflowStart

• eagerWorkflowStart: boolean

True if the namespace supports eager workflow start.

Implementation of

ICapabilities.eagerWorkflowStart

---

reportedProblemsSearchAttribute

• reportedProblemsSearchAttribute: boolean

True if the namespace supports reported problems search attribute

Implementation of

ICapabilities.reportedProblemsSearchAttribute

---

standaloneActivities

• standaloneActivities: boolean

True if the namespace supports standalone activities

Implementation of

ICapabilities.standaloneActivities

---

syncUpdate

• syncUpdate: boolean

True if the namespace supports sync update

Implementation of

ICapabilities.syncUpdate

---

workerHeartbeats

• workerHeartbeats: boolean

True if the namespace supports worker heartbeats

Implementation of

ICapabilities.workerHeartbeats

---

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.

Implementation of

ICapabilities.workerPollCompleteOnShutdown

---

workflowPause

• workflowPause: boolean

True if the namespace supports pausing workflows

Implementation of

ICapabilities.workflowPause

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