IResultWarning
Represents an execution result warning. (e.g. when execution was executed successfully, but backend didn’t take something into the account)
export interface IResultWarning
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
string | Human readable representation of the execution warning. | ||
(ObjRef | string)[] | (Optional) Execution warning parameters (e.g. when filter was not applied - its ObjRef) | ||
string | Unique identifier of the execution warning |
Property details
IResultWarning.messageproperty
Human readable representation of the execution warning.
message: string;
Remarks
With C-like printf parameter placeholders. The values for the placeholders are in the parameters array in the order in which they should replace the placeholders.
Example: “metric filter on dimension [%s] not applied”
IResultWarning.parametersproperty
Execution warning parameters (e.g. when filter was not applied - its ObjRef)
parameters?: (ObjRef | string)[];
IResultWarning.warningCodeproperty
Unique identifier of the execution warning
warningCode: string;