Class: WorkflowDefinition
(-- api-linter: core::0203::optional=disabled --)
Implements
Constructors
constructor
• new WorkflowDefinition(properties?): WorkflowDefinition
Constructs a new WorkflowDefinition.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IWorkflowDefinition | Properties to set |
Returns
Properties
description
• description: string
An optional workflow description provided by the application. By convention, external tools may interpret its first part, i.e., ending with a line break, as a summary of the description.
Implementation of
IWorkflowDefinition.description
queryDefinitions
• queryDefinitions: IWorkflowInteractionDefinition[]
WorkflowDefinition queryDefinitions.
Implementation of
IWorkflowDefinition.queryDefinitions
signalDefinitions
• signalDefinitions: IWorkflowInteractionDefinition[]
WorkflowDefinition signalDefinitions.
Implementation of
IWorkflowDefinition.signalDefinitions
type
• type: string
A name scoped by the task queue that maps to this workflow definition. If missing, this workflow is a dynamic workflow.
Implementation of
updateDefinitions
• updateDefinitions: IWorkflowInteractionDefinition[]
WorkflowDefinition updateDefinitions.
Implementation of
IWorkflowDefinition.updateDefinitions
Methods
toJSON
▸ toJSON(): Object
Converts this WorkflowDefinition to JSON.
Returns
Object
JSON object
create
▸ create(properties?): WorkflowDefinition
Creates a new WorkflowDefinition instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IWorkflowDefinition | Properties to set |
Returns
WorkflowDefinition instance
decode
▸ decode(reader, length?): WorkflowDefinition
Decodes a WorkflowDefinition 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
WorkflowDefinition
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): WorkflowDefinition
Decodes a WorkflowDefinition message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
WorkflowDefinition
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 WorkflowDefinition message. Does not implicitly temporal.api.sdk.v1.WorkflowDefinition.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IWorkflowDefinition | WorkflowDefinition message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified WorkflowDefinition message, length delimited. Does not implicitly temporal.api.sdk.v1.WorkflowDefinition.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IWorkflowDefinition | WorkflowDefinition message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): WorkflowDefinition
Creates a WorkflowDefinition message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
WorkflowDefinition
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for WorkflowDefinition
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 WorkflowDefinition message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | WorkflowDefinition | WorkflowDefinition |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object