SetTaskDisplay | Workflows

func SetTaskDisplay(ctx context.Context, display string) error

Set the display label of the currently executing task.

This function is intended to be used inside a task Execute method.

Parameters

ctx context.Context required

The task execution context.

display string required

The display label to set for the current task.

Returns

An error if the context is not a task execution context.

Usage example

func (t *ProcessScene) Execute(ctx context.Context) error {
    if err := workflows.SetTaskDisplay(
        ctx,
        "Process scene "+t.SceneID,
    ); err != nil {
        return err
    }
    return nil
}