Backstage
    Preparing search index...

    TaskBroker

    this interface is planned to be removed. Please reach out to us in an issue if you're using this interface and your use cases.

    interface TaskBroker {
        cancel(taskId: string): Promise<void>;
        claim(): Promise<TaskContext>;
        dispatch(
            options: TaskBrokerDispatchOptions,
        ): Promise<TaskBrokerDispatchResult>;
        event$(
            options: { after: number | undefined; taskId: string },
        ): Observable<{ events: SerializedTaskEvent[] }>;
        get(taskId: string): Promise<SerializedTask>;
        list(
            options?: {
                filters?: {
                    createdBy?: string | string[];
                    status?: TaskStatus | TaskStatus[];
                };
                order?: { field: string; order: "asc"
                | "desc" }[];
                pagination?: { limit?: number; offset?: number };
                permissionFilters?: PermissionCriteria<TaskFilters>;
            },
        ): Promise<{ tasks: SerializedTask[]; totalTasks?: number }>;
        recoverTasks(): Promise<void>;
        retry(options: { secrets?: TaskSecrets; taskId: string }): Promise<void>;
        vacuumTasks(options: { timeoutS: number }): Promise<void>;
    }
    Index

    Methods

    • Parameters

      • Optionaloptions: {
            filters?: {
                createdBy?: string | string[];
                status?: TaskStatus | TaskStatus[];
            };
            order?: { field: string; order: "asc"
            | "desc" }[];
            pagination?: { limit?: number; offset?: number };
            permissionFilters?: PermissionCriteria<TaskFilters>;
        }

      Returns Promise<{ tasks: SerializedTask[]; totalTasks?: number }>