Class: Capabilities
v1.RespondWorkflowTaskCompletedRequest.Capabilities
SDK capability details.
Implements
Constructors
constructor
• new Capabilities(properties?): Capabilities
Constructs a new Capabilities.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | ICapabilities | Properties to set |
Returns
Properties
discardSpeculativeWorkflowTaskWithEvents
• discardSpeculativeWorkflowTaskWithEvents: boolean
True if the SDK can handle speculative workflow task with command events. If true, the server may chosse, at its discretion, to discard a speculative workflow task even if that speculative task included command events the SDK had not previouly processed
(-- api-linter: core::0140::prepositions=disabled aip.dev/not-precedent: "with" used to describe the workflow task. --)
Implementation of
ICapabilities.discardSpeculativeWorkflowTaskWithEvents
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 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
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
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.RespondWorkflowTaskCompletedRequest.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.RespondWorkflowTaskCompletedRequest.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
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