Skip to main content

Interface: ActivityDescribeOptions

client.ActivityDescribeOptions

Options for ActivityHandle.describe.

Standalone Activities are experimental. APIs may be subject to change.

Properties

includeHeartbeatDetails

Optional includeHeartbeatDetails: boolean

Include heartbeat details in the response if available.


includeInput

Optional includeInput: boolean

Include activity input in the response if available.


includeLastFailure

Optional includeLastFailure: boolean

Include last failure in the response if available.


includeOutcome

Optional includeOutcome: boolean

Include activity outcome failure in the response if available. If the activity is closed, this will populate either ActivityExecutionDescription.getResult or ActivityExecutionDescription.getOutcomeFailure depending on whether the activity succeeded or failed.