Class: WorkflowExecutionCancelRequestedEventAttributes
history.v1.WorkflowExecutionCancelRequestedEventAttributes
Represents a WorkflowExecutionCancelRequestedEventAttributes.
Properties
cause
• cause: string
User provided reason for requesting cancellation
externalInitiatedEventId
• externalInitiatedEventId: Long
The ID of the REQUEST_CANCEL_EXTERNAL_WORKFLOW_EXECUTION_INITIATED event in the external
workflow history when the cancellation was requested by another workflow.
externalWorkflowExecution
• Optional externalWorkflowExecution: null | $Properties
WorkflowExecutionCancelRequestedEventAttributes externalWorkflowExecution.
identity
• identity: string
id of the worker or client who requested this cancel
Methods
toJSON
▸ toJSON(): Object
Converts this WorkflowExecutionCancelRequestedEventAttributes to JSON.
Returns
Object
JSON object
create
▸ create(properties?): WorkflowExecutionCancelRequestedEventAttributes & $Properties
Creates a new WorkflowExecutionCancelRequestedEventAttributes instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Properties | Properties to set |
Returns
WorkflowExecutionCancelRequestedEventAttributes & $Properties
WorkflowExecutionCancelRequestedEventAttributes instance
▸ create(properties?): WorkflowExecutionCancelRequestedEventAttributes
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
WorkflowExecutionCancelRequestedEventAttributes
decode
▸ decode(reader, length?): WorkflowExecutionCancelRequestedEventAttributes & $Properties
Decodes a WorkflowExecutionCancelRequestedEventAttributes 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
WorkflowExecutionCancelRequestedEventAttributes & $Properties
WorkflowExecutionCancelRequestedEventAttributes
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): WorkflowExecutionCancelRequestedEventAttributes & $Properties
Decodes a WorkflowExecutionCancelRequestedEventAttributes message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
WorkflowExecutionCancelRequestedEventAttributes & $Properties
WorkflowExecutionCancelRequestedEventAttributes
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 WorkflowExecutionCancelRequestedEventAttributes message. Does not implicitly temporal.api.history.v1.WorkflowExecutionCancelRequestedEventAttributes.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | WorkflowExecutionCancelRequestedEventAttributes message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified WorkflowExecutionCancelRequestedEventAttributes message, length delimited. Does not implicitly temporal.api.history.v1.WorkflowExecutionCancelRequestedEventAttributes.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | WorkflowExecutionCancelRequestedEventAttributes message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): WorkflowExecutionCancelRequestedEventAttributes
Creates a WorkflowExecutionCancelRequestedEventAttributes message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
WorkflowExecutionCancelRequestedEventAttributes
WorkflowExecutionCancelRequestedEventAttributes
toObject
▸ toObject(message, options?): Object
Creates a plain object from a WorkflowExecutionCancelRequestedEventAttributes message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | WorkflowExecutionCancelRequestedEventAttributes | WorkflowExecutionCancelRequestedEventAttributes |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object