Skip to main content

Interface: IRequestCancelWorkflowExecutionRequest

workflowservice.v1.IRequestCancelWorkflowExecutionRequest

Properties of a RequestCancelWorkflowExecutionRequest.

Hierarchy​

  • $Properties

    ↳ IRequestCancelWorkflowExecutionRequest

Properties​

firstExecutionRunId​

• Optional firstExecutionRunId: null | string

If set, this call will error if the most recent (if no run id is set on workflow_execution), or specified (if it is) workflow execution is not part of the same execution chain as this id.

Inherited from​

$Properties.firstExecutionRunId

identity​

• Optional identity: null | string

The identity of the worker/client

Inherited from​

$Properties.identity

• Optional links: null | $Properties[]

Links to be associated with the WorkflowExecutionCanceled event.

Inherited from​

$Properties.links

namespace​

• Optional namespace: null | string

RequestCancelWorkflowExecutionRequest namespace

Inherited from​

$Properties.namespace

reason​

• Optional reason: null | string

Reason for requesting the cancellation

Inherited from​

$Properties.reason

requestId​

• Optional requestId: null | string

Used to de-dupe cancellation requests

Inherited from​

$Properties.requestId

workflowExecution​

• Optional workflowExecution: null | $Properties

RequestCancelWorkflowExecutionRequest workflowExecution

Inherited from​

$Properties.workflowExecution