Options
All
  • Public
  • Public/Protected
  • All
Menu

Result from goal execution.

Instead of returning ExecuteGoalResult, it is ok to throw an Error to signal errors during goal execution.

Hierarchy

Index

Properties

Optional code

code: number

0, undefined or null is success; non-zero exit codes will mark the goal as failed, if state is not defined

Optional data

data: string

Update the goals data field

Optional description

description: string

Optional description to be set on the goal

Optional externalUrls

externalUrls: Array<object>

Optional externalUrls to be set on the goal

Optional message

message: string

The simple text message describing the result

Optional phase

phase: string

Optional phase to return from the goal execution

Optional requireApproval

requireApproval: boolean

Optional flag to indicate if this goal requires approval now

deprecated

use state = SdmGoalState.waiting_for_approval instead

Optional state

Optional state for the goal

Optional targetUrl

targetUrl: string

Optional targetUrl to be set on the goal as externalUrl

deprecated

use externalsUrls

Optional targetUrls

targetUrls: Array<object>

Optional targetUrls to be set on the goal as externalUrls

deprecated

use externalsUrls

Generated using TypeDoc