Class: WorkflowExecutionCompletedEventAttributes
history.v1.WorkflowExecutionCompletedEventAttributes
Represents a WorkflowExecutionCompletedEventAttributes.
Implements
Constructors
constructor
• new WorkflowExecutionCompletedEventAttributes(properties?): WorkflowExecutionCompletedEventAttributes
Constructs a new WorkflowExecutionCompletedEventAttributes.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IWorkflowExecutionCompletedEventAttributes | Properties to set |
Returns
WorkflowExecutionCompletedEventAttributes
Properties
newExecutionRunId
• newExecutionRunId: string
If another run is started by cron, this contains the new run id.
Implementation of
IWorkflowExecutionCompletedEventAttributes.newExecutionRunId
result
• Optional result: null | IPayloads
Serialized result of workflow completion (ie: The return value of the workflow function)
Implementation of
IWorkflowExecutionCompletedEventAttributes.result
workflowTaskCompletedEventId
• workflowTaskCompletedEventId: Long
The WORKFLOW_TASK_COMPLETED event which this command was reported with
Implementation of
IWorkflowExecutionCompletedEventAttributes.workflowTaskCompletedEventId
Methods
toJSON
▸ toJSON(): Object
Converts this WorkflowExecutionCompletedEventAttributes to JSON.
Returns
Object
JSON object
create
▸ create(properties?): WorkflowExecutionCompletedEventAttributes
Creates a new WorkflowExecutionCompletedEventAttributes instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IWorkflowExecutionCompletedEventAttributes | Properties to set |
Returns
WorkflowExecutionCompletedEventAttributes
WorkflowExecutionCompletedEventAttributes instance
decode
▸ decode(reader, length?): WorkflowExecutionCompletedEventAttributes
Decodes a WorkflowExecutionCompletedEventAttributes 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
WorkflowExecutionCompletedEventAttributes
WorkflowExecutionCompletedEventAttributes
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): WorkflowExecutionCompletedEventAttributes
Decodes a WorkflowExecutionCompletedEventAttributes message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
WorkflowExecutionCompletedEventAttributes
WorkflowExecutionCompletedEventAttributes
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 WorkflowExecutionCompletedEventAttributes message. Does not implicitly temporal.api.history.v1.WorkflowExecutionCompletedEventAttributes.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IWorkflowExecutionCompletedEventAttributes | WorkflowExecutionCompletedEventAttributes message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified WorkflowExecutionCompletedEventAttributes message, length delimited. Does not implicitly temporal.api.history.v1.WorkflowExecutionCompletedEventAttributes.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IWorkflowExecutionCompletedEventAttributes | WorkflowExecutionCompletedEventAttributes message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): WorkflowExecutionCompletedEventAttributes
Creates a WorkflowExecutionCompletedEventAttributes message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
WorkflowExecutionCompletedEventAttributes
WorkflowExecutionCompletedEventAttributes
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for WorkflowExecutionCompletedEventAttributes
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 WorkflowExecutionCompletedEventAttributes message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | WorkflowExecutionCompletedEventAttributes | WorkflowExecutionCompletedEventAttributes |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object