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