setExecutionResultErrorWithResult()

Home > @gooddata/sdk-ui-dashboard > setExecutionResultErrorWithResult

setExecutionResultErrorWithResult() function

This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Creates an IUpsertExecutionResult command for an execution that finished with an error but still produced a result.

Signature:

export declare function setExecutionResultErrorWithResult(options: {
    id: ObjRef | string;
    error: GoodDataSdkError;
    executionResult: IExecutionResult;
    correlationId?: string;
}): IUpsertExecutionResult;

Parameters

Parameter	Type	Description
options	{ id: ObjRef | string; error: GoodDataSdkError; executionResult: IExecutionResult; correlationId?: string; }

Returns:

IUpsertExecutionResult

Remarks

An empty-but-valid execution computes a result (with a resultId) yet surfaces as a no-data error. Recording the result alongside the error lets consumers reference it (e.g. by resultId) while the error keeps the widget in its terminal error state — including the non-exportable gating that the presence of the result alone would otherwise lift.