 | TemporalClientTerminateWorkflowAsync Method |
Terminates a workflow if it has not already finished.
Namespace:
Neon.Temporal
Assembly:
Neon.Temporal (in Neon.Temporal.dll) Version: 2.10.0-alpha
Syntaxpublic Task TerminateWorkflowAsync(
WorkflowExecution execution,
string reason = null,
byte[] details = null,
string namespace = null
)
Public Function TerminateWorkflowAsync (
execution As WorkflowExecution,
Optional reason As String = Nothing,
Optional details As Byte() = Nothing,
Optional namespace As String = Nothing
) As Task
public:
Task^ TerminateWorkflowAsync(
WorkflowExecution^ execution,
String^ reason = nullptr,
array<unsigned char>^ details = nullptr,
String^ namespace = nullptr
)
member TerminateWorkflowAsync :
execution : WorkflowExecution *
?reason : string *
?details : byte[] *
?namespace : string
(* Defaults:
let _reason = defaultArg reason null
let _details = defaultArg details null
let _namespace = defaultArg namespace null
*)
-> Task
Parameters
- execution
- Type: Neon.TemporalWorkflowExecution
Identifies the running workflow. - reason (Optional)
- Type: SystemString
Optionally specifies an error reason string. - details (Optional)
- Type: SystemByte
Optionally specifies additional details as a byte array. - namespace (Optional)
- Type: SystemString
Optionally specifies the namespace. This defaults to the client namespace.
Return Value
Type:
TaskThe tracking
Task.
Exceptions
See Also