Class: RequestCancelExternalWorkflowExecutionFailedEventAttributes
history.v1.RequestCancelExternalWorkflowExecutionFailedEventAttributes
Represents a RequestCancelExternalWorkflowExecutionFailedEventAttributes.
Properties
cause
• cause: CancelExternalWorkflowExecutionFailedCause
RequestCancelExternalWorkflowExecutionFailedEventAttributes cause.
control
• control: string
Deprecated.
initiatedEventId
• initiatedEventId: Long
id of the REQUEST_CANCEL_EXTERNAL_WORKFLOW_EXECUTION_INITIATED event this failure
corresponds to
namespace
• namespace: string
Namespace of the workflow which failed to cancel.
SDKs and UI tools should use namespace field but server must use namespace_id only.
namespaceId
• namespaceId: string
RequestCancelExternalWorkflowExecutionFailedEventAttributes namespaceId.
workflowExecution
• Optional workflowExecution: null | $Properties
RequestCancelExternalWorkflowExecutionFailedEventAttributes workflowExecution.
workflowTaskCompletedEventId
• workflowTaskCompletedEventId: Long
The WORKFLOW_TASK_COMPLETED event which this command was reported with
Methods
toJSON
▸ toJSON(): Object
Converts this RequestCancelExternalWorkflowExecutionFailedEventAttributes to JSON.
Returns
Object
JSON object
create
▸ create(properties?): RequestCancelExternalWorkflowExecutionFailedEventAttributes & $Properties
Creates a new RequestCancelExternalWorkflowExecutionFailedEventAttributes instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Properties | Properties to set |
Returns
RequestCancelExternalWorkflowExecutionFailedEventAttributes & $Properties
RequestCancelExternalWorkflowExecutionFailedEventAttributes instance
▸ create(properties?): RequestCancelExternalWorkflowExecutionFailedEventAttributes
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
RequestCancelExternalWorkflowExecutionFailedEventAttributes
decode
▸ decode(reader, length?): RequestCancelExternalWorkflowExecutionFailedEventAttributes & $Properties
Decodes a RequestCancelExternalWorkflowExecutionFailedEventAttributes 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
RequestCancelExternalWorkflowExecutionFailedEventAttributes & $Properties
RequestCancelExternalWorkflowExecutionFailedEventAttributes
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): RequestCancelExternalWorkflowExecutionFailedEventAttributes & $Properties
Decodes a RequestCancelExternalWorkflowExecutionFailedEventAttributes message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
RequestCancelExternalWorkflowExecutionFailedEventAttributes & $Properties
RequestCancelExternalWorkflowExecutionFailedEventAttributes
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 RequestCancelExternalWorkflowExecutionFailedEventAttributes message. Does not implicitly temporal.api.history.v1.RequestCancelExternalWorkflowExecutionFailedEventAttributes.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | RequestCancelExternalWorkflowExecutionFailedEventAttributes message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified RequestCancelExternalWorkflowExecutionFailedEventAttributes message, length delimited. Does not implicitly temporal.api.history.v1.RequestCancelExternalWorkflowExecutionFailedEventAttributes.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | RequestCancelExternalWorkflowExecutionFailedEventAttributes message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): RequestCancelExternalWorkflowExecutionFailedEventAttributes
Creates a RequestCancelExternalWorkflowExecutionFailedEventAttributes message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
RequestCancelExternalWorkflowExecutionFailedEventAttributes
RequestCancelExternalWorkflowExecutionFailedEventAttributes
toObject
▸ toObject(message, options?): Object
Creates a plain object from a RequestCancelExternalWorkflowExecutionFailedEventAttributes message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | RequestCancelExternalWorkflowExecutionFailedEventAttributes | RequestCancelExternalWorkflowExecutionFailedEventAttributes |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object