@keboola/api-client 25.0.0 → 27.0.0

package/surface/queue.md

@@ -4,10 +4,11 @@
 
 Part of the [`@keboola/api-client` surface index](../API-SURFACE.md).
 
-- `api.queue.createJob(body: { component: string; mode?: "run" | "debug" | "forceRun" | undefined; config?: string | undefined; configRowIds?: string[] | undefined; configData?: Record<string, never> | undefined; tag?: string | undefined; branchId?: string | undefined; variableValuesId?: string | undefined; variableValuesData?: { values: { name: string; value: string; }[]; } | undefined; backend?: { type: "small" | "xsmall" | "medium" | "large"; context?: string | undefined; } | undefined; executor?: "dind" | "k8sContainers" | undefined; delayedStartTime?: string | undefined; delay?: number | undefined; }, signal?: AbortSignal | undefined): Promise<{ id: string; runId: string; branchId?: string | undefined; project: { id: string; }; token: { id?: string | undefined; description?: string | undefined; }; status: "error" | "success" | "warning" | "created" | "waiting" | "processing" | "terminating" | "terminated" | "cancelled"; desiredStatus?: "processing" | "terminating" | null | undefined; component: string; mode: "run" | "debug"; tag?: string | null | undefined; config?: string | null | undefined; configRow?: string | null | undefined; configData?: Record<string, never> | null | undefined; result?: { images?: { digests?: string[] | undefined; id?: string | undefined; }[] | undefined; configVersion?: number | undefined; message?: string | undefined; } | null | undefined; createdTime: string; startTime?: string | null | undefined; endTime?: string | null | undefined; delayedStartTime?: string | null | undefined; durationSeconds?: number | null | undefined; isFinished: boolean; url: string; variableValuesId?: string | null | undefined; variableValuesData?: { values?: { name?: string | undefined; value?: string | undefined; }[] | undefined; } | null | undefined; backend?: { type?: string | undefined; containerType?: string | undefined; context?: string | undefined; } | null | undefined; metrics?: { storage?: { inputTablesBytesSum?: number | undefined; outputTablesBytesSum?: number | undefined; } | undefined; backend?: { type?: string | undefined; containerType?: string | undefined; context?: string | undefined; } | undefined; } | null | undefined; type?: "standard" | "container" | "phaseContainer" | "orchestrationContainer" | "retryContainer" | undefined; orchestrationTaskId?: string | null | undefined; previousJobId?: string | null | undefined; onlyOrchestrationTaskIds?: string[] | null | undefined; }>`
-- `api.queue.getJob(jobId: string, signal?: AbortSignal | undefined): Promise<{ id: string; runId: string; branchId?: string | undefined; project: { id: string; }; token: { id?: string | undefined; description?: string | undefined; }; status: "error" | "success" | "warning" | "created" | "waiting" | "processing" | "terminating" | "terminated" | "cancelled"; desiredStatus?: "processing" | "terminating" | null | undefined; component: string; mode: "run" | "debug"; tag?: string | null | undefined; config?: string | null | undefined; configRow?: string | null | undefined; configData?: Record<string, never> | null | undefined; result?: { images?: { digests?: string[] | undefined; id?: string | undefined; }[] | undefined; configVersion?: number | undefined; message?: string | undefined; } | null | undefined; createdTime: string; startTime?: string | null | undefined; endTime?: string | null | undefined; delayedStartTime?: string | null | undefined; durationSeconds?: number | null | undefined; isFinished: boolean; url: string; variableValuesId?: string | null | undefined; variableValuesData?: { values?: { name?: string | undefined; value?: string | undefined; }[] | undefined; } | null | undefined; backend?: { type?: string | undefined; containerType?: string | undefined; context?: string | undefined; } | null | undefined; metrics?: { storage?: { inputTablesBytesSum?: number | undefined; outputTablesBytesSum?: number | undefined; } | undefined; backend?: { type?: string | undefined; containerType?: string | undefined; context?: string | undefined; } | undefined; } | null | undefined; type?: "standard" | "container" | "phaseContainer" | "orchestrationContainer" | "retryContainer" | undefined; orchestrationTaskId?: string | null | undefined; previousJobId?: string | null | undefined; onlyOrchestrationTaskIds?: string[] | null | undefined; }>`
+- `api.queue.createJob(body: { component: string; mode?: "run" | "debug" | "forceRun" | undefined; config?: string | undefined; configRowIds?: string[] | undefined; configData?: Record<string, never> | undefined; tag?: string | undefined; branchId?: string | undefined; variableValuesId?: string | undefined; variableValuesData?: { values: { name: string; value: string; }[]; } | undefined; backend?: { type: "small" | "medium" | "large" | "xsmall"; context?: string | undefined; } | undefined; executor?: "dind" | "k8sContainers" | undefined; delayedStartTime?: string | undefined; delay?: number | undefined; onlyFlowTaskIds?: string[] | null | undefined; onlyOrchestrationTaskIds?: string[] | null | undefined; }, signal?: AbortSignal | undefined): Promise<{ id: string; runId: string; branchId?: string | undefined; project: { id: string; }; token: { id?: string | undefined; description?: string | undefined; }; status: "error" | "success" | "warning" | "created" | "waiting" | "processing" | "terminating" | "terminated" | "cancelled"; desiredStatus?: "processing" | "terminating" | null | undefined; component: string; mode: "run" | "debug"; tag?: string | null | undefined; config?: string | null | undefined; configRow?: string | null | undefined; configData?: Record<string, never> | null | undefined; result?: { images?: { digests?: string[] | undefined; id?: string | undefined; }[] | undefined; configVersion?: number | undefined; message?: string | undefined; } | null | undefined; createdTime: string; startTime?: string | null | undefined; endTime?: string | null | undefined; delayedStartTime?: string | null | undefined; durationSeconds?: number | null | undefined; isFinished: boolean; url: string; variableValuesId?: string | null | undefined; variableValuesData?: { values?: { name?: string | undefined; value?: string | undefined; }[] | undefined; } | null | undefined; backend?: { type?: string | undefined; containerType?: string | undefined; context?: string | undefined; } | null | undefined; metrics?: { storage?: { inputTablesBytesSum?: number | undefined; outputTablesBytesSum?: number | undefined; } | undefined; backend?: { type?: string | undefined; containerType?: string | undefined; context?: string | undefined; } | undefined; } | null | undefined; type?: "standard" | "container" | "phaseContainer" | "orchestrationContainer" | "retryContainer" | undefined; orchestrationTaskId?: string | null | undefined; previousJobId?: string | null | undefined; onlyOrchestrationTaskIds?: string[] | null | undefined; onlyFlowTaskIds?: string[] | null | undefined; }>`
+- `api.queue.getJob(jobId: string, signal?: AbortSignal | undefined): Promise<{ id: string; runId: string; branchId?: string | undefined; project: { id: string; }; token: { id?: string | undefined; description?: string | undefined; }; status: "error" | "success" | "warning" | "created" | "waiting" | "processing" | "terminating" | "terminated" | "cancelled"; desiredStatus?: "processing" | "terminating" | null | undefined; component: string; mode: "run" | "debug"; tag?: string | null | undefined; config?: string | null | undefined; configRow?: string | null | undefined; configData?: Record<string, never> | null | undefined; result?: { images?: { digests?: string[] | undefined; id?: string | undefined; }[] | undefined; configVersion?: number | undefined; message?: string | undefined; } | null | undefined; createdTime: string; startTime?: string | null | undefined; endTime?: string | null | undefined; delayedStartTime?: string | null | undefined; durationSeconds?: number | null | undefined; isFinished: boolean; url: string; variableValuesId?: string | null | undefined; variableValuesData?: { values?: { name?: string | undefined; value?: string | undefined; }[] | undefined; } | null | undefined; backend?: { type?: string | undefined; containerType?: string | undefined; context?: string | undefined; } | null | undefined; metrics?: { storage?: { inputTablesBytesSum?: number | undefined; outputTablesBytesSum?: number | undefined; } | undefined; backend?: { type?: string | undefined; containerType?: string | undefined; context?: string | undefined; } | undefined; } | null | undefined; type?: "standard" | "container" | "phaseContainer" | "orchestrationContainer" | "retryContainer" | undefined; orchestrationTaskId?: string | null | undefined; previousJobId?: string | null | undefined; onlyOrchestrationTaskIds?: string[] | null | undefined; onlyFlowTaskIds?: string[] | null | undefined; }>`
 - `api.queue.getOrchestrationRerunPlan(jobId: string, signal?: AbortSignal | undefined): Promise<{ jobId?: string | undefined; configId?: string | null | undefined; matchedTasks?: { taskId?: string | undefined; matched?: boolean | undefined; jobId?: string | null | undefined; componentId?: string | null | undefined; configId?: string | null | undefined; status?: "error" | "success" | "warning" | "created" | "waiting" | "processing" | "terminating" | "terminated" | "cancelled" | undefined; }[] | undefined; }>`
-- `api.queue.killJob(jobId: string, signal?: AbortSignal | undefined): Promise<{ id: string; runId: string; branchId?: string | undefined; project: { id: string; }; token: { id?: string | undefined; description?: string | undefined; }; status: "error" | "success" | "warning" | "created" | "waiting" | "processing" | "terminating" | "terminated" | "cancelled"; desiredStatus?: "processing" | "terminating" | null | undefined; component: string; mode: "run" | "debug"; tag?: string | null | undefined; config?: string | null | undefined; configRow?: string | null | undefined; configData?: Record<string, never> | null | undefined; result?: { images?: { digests?: string[] | undefined; id?: string | undefined; }[] | undefined; configVersion?: number | undefined; message?: string | undefined; } | null | undefined; createdTime: string; startTime?: string | null | undefined; endTime?: string | null | undefined; delayedStartTime?: string | null | undefined; durationSeconds?: number | null | undefined; isFinished: boolean; url: string; variableValuesId?: string | null | undefined; variableValuesData?: { values?: { name?: string | undefined; value?: string | undefined; }[] | undefined; } | null | undefined; backend?: { type?: string | undefined; containerType?: string | undefined; context?: string | undefined; } | null | undefined; metrics?: { storage?: { inputTablesBytesSum?: number | undefined; outputTablesBytesSum?: number | undefined; } | undefined; backend?: { type?: string | undefined; containerType?: string | undefined; context?: string | undefined; } | undefined; } | null | undefined; type?: "standard" | "container" | "phaseContainer" | "orchestrationContainer" | "retryContainer" | undefined; orchestrationTaskId?: string | null | undefined; previousJobId?: string | null | undefined; onlyOrchestrationTaskIds?: string[] | null | undefined; }>`
-- `api.queue.searchAllJobs(query: { branchId?: string[] | undefined; runId?: string[] | undefined; mode?: ("run" | "debug")[] | undefined; componentId?: string[] | undefined; configId?: string[] | undefined; id?: string[] | undefined; type?: "standard" | "container" | "phaseContainer" | "orchestrationContainer" | "retryContainer" | undefined; tokenId?: string[] | undefined; tokenDescription?: string[] | undefined; component?: string[] | undefined; config?: string[] | undefined; configRowIds?: string[] | undefined; status?: ("error" | "success" | "warning" | "created" | "waiting" | "processing" | "terminating" | "terminated" | "cancelled")[] | undefined; componentProps?: { type?: string | undefined; } | undefined; createdTimeFrom?: string | undefined; createdTimeTo?: string | undefined; startTimeFrom?: string | undefined; startTimeTo?: string | undefined; endTimeFrom?: string | undefined; endTimeTo?: string | undefined; durationSecondsFrom?: number | undefined; durationSecondsTo?: number | undefined; limit?: number | undefined; sortBy?: "projectId" | "branchId" | "runId" | "componentId" | "configId" | "id" | "tokenDescription" | "status" | "createdTime" | "durationSeconds" | "startTime" | "endTime" | "updatedTime" | undefined; sortOrder?: "asc" | "desc" | undefined; parentRunId?: string | undefined; }, signal?: AbortSignal | undefined): Promise<{ id: string; runId: string; branchId?: string | undefined; project: { id: string; }; token: { id?: string | undefined; description?: string | undefined; }; status: "error" | "success" | "warning" | "created" | "waiting" | "processing" | "terminating" | "terminated" | "cancelled"; desiredStatus?: "processing" | "terminating" | null | undefined; component: string; mode: "run" | "debug"; tag?: string | null | undefined; config?: string | null | undefined; configRow?: string | null | undefined; configData?: Record<string, never> | null | undefined; result?: { images?: { digests?: string[] | undefined; id?: string | undefined; }[] | undefined; configVersion?: number | undefined; message?: string | undefined; } | null | undefined; createdTime: string; startTime?: string | null | undefined; endTime?: string | null | undefined; delayedStartTime?: string | null | undefined; durationSeconds?: number | null | undefined; isFinished: boolean; url: string; variableValuesId?: string | null | undefined; variableValuesData?: { values?: { name?: string | undefined; value?: string | undefined; }[] | undefined; } | null | undefined; backend?: { type?: string | undefined; containerType?: string | undefined; context?: string | undefined; } | null | undefined; metrics?: { storage?: { inputTablesBytesSum?: number | undefined; outputTablesBytesSum?: number | undefined; } | undefined; backend?: { type?: string | undefined; containerType?: string | undefined; context?: string | undefined; } | undefined; } | null | undefined; type?: "standard" | "container" | "phaseContainer" | "orchestrationContainer" | "retryContainer" | undefined; orchestrationTaskId?: string | null | undefined; previousJobId?: string | null | undefined; onlyOrchestrationTaskIds?: string[] | null | undefined; }[]>`
-- `api.queue.searchGroupedJobs(query: { groupBy: ("projectId" | "branchId" | "componentId" | "configId")[]; jobsPerGroup?: number | undefined; sortBy?: "projectId" | "branchId" | "runId" | "componentId" | "configId" | "id" | "tokenDescription" | "status" | "createdTime" | "durationSeconds" | "startTime" | "endTime" | "updatedTime" | undefined; sortOrder?: "asc" | "desc" | undefined; limit?: number | undefined; id?: number[] | undefined; runId?: string[] | undefined; branchId?: string[] | undefined; configId?: string[] | undefined; config?: string[] | undefined; configRowIds?: string[] | undefined; projectId?: string[] | undefined; tokenId?: string[] | undefined; tokenDescription?: string[] | undefined; componentId?: string[] | undefined; component?: string[] | undefined; status?: string[] | undefined; desiredStatus?: string[] | undefined; mode?: string[] | undefined; tag?: string[] | undefined; startTimeFrom?: string | undefined; startTimeTo?: string | undefined; createdTimeFrom?: string | undefined; createdTimeTo?: string | undefined; endTimeFrom?: string | undefined; endTimeTo?: string | undefined; durationSecondsFrom?: number | undefined; durationSecondsTo?: number | undefined; variableValuesId?: string[] | undefined; parentRunId?: string[] | undefined; type?: string[] | undefined; componentProps?: { type?: string | undefined; } | undefined; }, signal?: AbortSignal | undefined): Promise<{ group?: { [key: string]: string; } | undefined; jobs?: { id: string; runId: string; branchId?: string | undefined; project: { id: string; }; token: { id?: string | undefined; description?: string | undefined; }; status: "error" | "success" | "warning" | "created" | "waiting" | "processing" | "terminating" | "terminated" | "cancelled"; desiredStatus?: "processing" | "terminating" | null | undefined; component: string; mode: "run" | "debug"; tag?: string | null | undefined; config?: string | null | undefined; configRow?: string | null | undefined; configData?: Record<string, never> | null | undefined; result?: { images?: { digests?: string[] | undefined; id?: string | undefined; }[] | undefined; configVersion?: number | undefined; message?: string | undefined; } | null | undefined; createdTime: string; startTime?: string | null | undefined; endTime?: string | null | undefined; delayedStartTime?: string | null | undefined; durationSeconds?: number | null | undefined; isFinished: boolean; url: string; variableValuesId?: string | null | undefined; variableValuesData?: { values?: { name?: string | undefined; value?: string | undefined; }[] | undefined; } | null | undefined; backend?: { type?: string | undefined; containerType?: string | undefined; context?: string | undefined; } | null | undefined; metrics?: { storage?: { inputTablesBytesSum?: number | undefined; outputTablesBytesSum?: number | undefined; } | undefined; backend?: { type?: string | undefined; containerType?: string | undefined; context?: string | undefined; } | undefined; } | null | undefined; type?: "standard" | "container" | "phaseContainer" | "orchestrationContainer" | "retryContainer" | undefined; orchestrationTaskId?: string | null | undefined; previousJobId?: string | null | undefined; onlyOrchestrationTaskIds?: string[] | null | undefined; }[] | undefined; }[]>`
-- `api.queue.searchJobs(query?: { id?: string[] | undefined; runId?: string[] | undefined; branchId?: string[] | undefined; tokenId?: string[] | undefined; tokenDescription?: string[] | undefined; componentId?: string[] | undefined; component?: string[] | undefined; configId?: string[] | undefined; config?: string[] | undefined; configRowIds?: string[] | undefined; mode?: ("run" | "debug")[] | undefined; status?: ("error" | "success" | "warning" | "created" | "waiting" | "processing" | "terminating" | "terminated" | "cancelled")[] | undefined; type?: "standard" | "container" | "phaseContainer" | "orchestrationContainer" | "retryContainer" | undefined; componentProps?: { type?: string | undefined; } | undefined; createdTimeFrom?: string | undefined; createdTimeTo?: string | undefined; startTimeFrom?: string | undefined; startTimeTo?: string | undefined; endTimeFrom?: string | undefined; endTimeTo?: string | undefined; durationSecondsFrom?: number | undefined; durationSecondsTo?: number | undefined; offset?: number | undefined; limit?: number | undefined; sortBy?: "projectId" | "branchId" | "runId" | "componentId" | "configId" | "id" | "tokenDescription" | "status" | "createdTime" | "durationSeconds" | "startTime" | "endTime" | "updatedTime" | undefined; sortOrder?: "asc" | "desc" | undefined; parentRunId?: string | undefined; } | undefined, signal?: AbortSignal | undefined): Promise<{ id: string; runId: string; branchId?: string | undefined; project: { id: string; }; token: { id?: string | undefined; description?: string | undefined; }; status: "error" | "success" | "warning" | "created" | "waiting" | "processing" | "terminating" | "terminated" | "cancelled"; desiredStatus?: "processing" | "terminating" | null | undefined; component: string; mode: "run" | "debug"; tag?: string | null | undefined; config?: string | null | undefined; configRow?: string | null | undefined; configData?: Record<string, never> | null | undefined; result?: { images?: { digests?: string[] | undefined; id?: string | undefined; }[] | undefined; configVersion?: number | undefined; message?: string | undefined; } | null | undefined; createdTime: string; startTime?: string | null | undefined; endTime?: string | null | undefined; delayedStartTime?: string | null | undefined; durationSeconds?: number | null | undefined; isFinished: boolean; url: string; variableValuesId?: string | null | undefined; variableValuesData?: { values?: { name?: string | undefined; value?: string | undefined; }[] | undefined; } | null | undefined; backend?: { type?: string | undefined; containerType?: string | undefined; context?: string | undefined; } | null | undefined; metrics?: { storage?: { inputTablesBytesSum?: number | undefined; outputTablesBytesSum?: number | undefined; } | undefined; backend?: { type?: string | undefined; containerType?: string | undefined; context?: string | undefined; } | undefined; } | null | undefined; type?: "standard" | "container" | "phaseContainer" | "orchestrationContainer" | "retryContainer" | undefined; orchestrationTaskId?: string | null | undefined; previousJobId?: string | null | undefined; onlyOrchestrationTaskIds?: string[] | null | undefined; }[]>`
+- `api.queue.healthCheck(signal?: AbortSignal | undefined): Promise<unknown>`
+- `api.queue.killJob(jobId: string, signal?: AbortSignal | undefined): Promise<{ id: string; runId: string; branchId?: string | undefined; project: { id: string; }; token: { id?: string | undefined; description?: string | undefined; }; status: "error" | "success" | "warning" | "created" | "waiting" | "processing" | "terminating" | "terminated" | "cancelled"; desiredStatus?: "processing" | "terminating" | null | undefined; component: string; mode: "run" | "debug"; tag?: string | null | undefined; config?: string | null | undefined; configRow?: string | null | undefined; configData?: Record<string, never> | null | undefined; result?: { images?: { digests?: string[] | undefined; id?: string | undefined; }[] | undefined; configVersion?: number | undefined; message?: string | undefined; } | null | undefined; createdTime: string; startTime?: string | null | undefined; endTime?: string | null | undefined; delayedStartTime?: string | null | undefined; durationSeconds?: number | null | undefined; isFinished: boolean; url: string; variableValuesId?: string | null | undefined; variableValuesData?: { values?: { name?: string | undefined; value?: string | undefined; }[] | undefined; } | null | undefined; backend?: { type?: string | undefined; containerType?: string | undefined; context?: string | undefined; } | null | undefined; metrics?: { storage?: { inputTablesBytesSum?: number | undefined; outputTablesBytesSum?: number | undefined; } | undefined; backend?: { type?: string | undefined; containerType?: string | undefined; context?: string | undefined; } | undefined; } | null | undefined; type?: "standard" | "container" | "phaseContainer" | "orchestrationContainer" | "retryContainer" | undefined; orchestrationTaskId?: string | null | undefined; previousJobId?: string | null | undefined; onlyOrchestrationTaskIds?: string[] | null | undefined; onlyFlowTaskIds?: string[] | null | undefined; }>`
+- `api.queue.searchAllJobs(query: { branchId?: string[] | undefined; runId?: string[] | undefined; mode?: ("run" | "debug")[] | undefined; componentId?: string[] | undefined; configId?: string[] | undefined; id?: string[] | undefined; type?: "standard" | "container" | "phaseContainer" | "orchestrationContainer" | "retryContainer" | undefined; tokenId?: string[] | undefined; tokenDescription?: string[] | undefined; component?: string[] | undefined; config?: string[] | undefined; configRowIds?: string[] | undefined; status?: ("error" | "success" | "warning" | "created" | "waiting" | "processing" | "terminating" | "terminated" | "cancelled")[] | undefined; componentProps?: { type?: string | undefined; } | undefined; createdTimeFrom?: string | undefined; createdTimeTo?: string | undefined; startTimeFrom?: string | undefined; startTimeTo?: string | undefined; endTimeFrom?: string | undefined; endTimeTo?: string | undefined; durationSecondsFrom?: number | undefined; durationSecondsTo?: number | undefined; limit?: number | undefined; sortBy?: "projectId" | "branchId" | "runId" | "componentId" | "configId" | "id" | "tokenDescription" | "status" | "createdTime" | "durationSeconds" | "startTime" | "endTime" | "updatedTime" | undefined; sortOrder?: "asc" | "desc" | undefined; parentRunId?: string | undefined; }, signal?: AbortSignal | undefined): Promise<{ id: string; runId: string; branchId?: string | undefined; project: { id: string; }; token: { id?: string | undefined; description?: string | undefined; }; status: "error" | "success" | "warning" | "created" | "waiting" | "processing" | "terminating" | "terminated" | "cancelled"; desiredStatus?: "processing" | "terminating" | null | undefined; component: string; mode: "run" | "debug"; tag?: string | null | undefined; config?: string | null | undefined; configRow?: string | null | undefined; configData?: Record<string, never> | null | undefined; result?: { images?: { digests?: string[] | undefined; id?: string | undefined; }[] | undefined; configVersion?: number | undefined; message?: string | undefined; } | null | undefined; createdTime: string; startTime?: string | null | undefined; endTime?: string | null | undefined; delayedStartTime?: string | null | undefined; durationSeconds?: number | null | undefined; isFinished: boolean; url: string; variableValuesId?: string | null | undefined; variableValuesData?: { values?: { name?: string | undefined; value?: string | undefined; }[] | undefined; } | null | undefined; backend?: { type?: string | undefined; containerType?: string | undefined; context?: string | undefined; } | null | undefined; metrics?: { storage?: { inputTablesBytesSum?: number | undefined; outputTablesBytesSum?: number | undefined; } | undefined; backend?: { type?: string | undefined; containerType?: string | undefined; context?: string | undefined; } | undefined; } | null | undefined; type?: "standard" | "container" | "phaseContainer" | "orchestrationContainer" | "retryContainer" | undefined; orchestrationTaskId?: string | null | undefined; previousJobId?: string | null | undefined; onlyOrchestrationTaskIds?: string[] | null | undefined; onlyFlowTaskIds?: string[] | null | undefined; }[]>`
+- `api.queue.searchGroupedJobs(query: { groupBy: ("projectId" | "branchId" | "componentId" | "configId")[]; jobsPerGroup?: number | undefined; sortBy?: "projectId" | "branchId" | "runId" | "componentId" | "configId" | "id" | "tokenDescription" | "status" | "createdTime" | "durationSeconds" | "startTime" | "endTime" | "updatedTime" | undefined; sortOrder?: "asc" | "desc" | undefined; limit?: number | undefined; id?: number[] | undefined; runId?: string[] | undefined; branchId?: string[] | undefined; configId?: string[] | undefined; config?: string[] | undefined; configRowIds?: string[] | undefined; projectId?: string[] | undefined; tokenId?: string[] | undefined; tokenDescription?: string[] | undefined; componentId?: string[] | undefined; component?: string[] | undefined; status?: string[] | undefined; desiredStatus?: string[] | undefined; mode?: string[] | undefined; tag?: string[] | undefined; startTimeFrom?: string | undefined; startTimeTo?: string | undefined; createdTimeFrom?: string | undefined; createdTimeTo?: string | undefined; endTimeFrom?: string | undefined; endTimeTo?: string | undefined; durationSecondsFrom?: number | undefined; durationSecondsTo?: number | undefined; variableValuesId?: string[] | undefined; parentRunId?: string[] | undefined; type?: string[] | undefined; componentProps?: { type?: string | undefined; } | undefined; }, signal?: AbortSignal | undefined): Promise<{ group?: { [key: string]: string; } | undefined; jobs?: { id: string; runId: string; branchId?: string | undefined; project: { id: string; }; token: { id?: string | undefined; description?: string | undefined; }; status: "error" | "success" | "warning" | "created" | "waiting" | "processing" | "terminating" | "terminated" | "cancelled"; desiredStatus?: "processing" | "terminating" | null | undefined; component: string; mode: "run" | "debug"; tag?: string | null | undefined; config?: string | null | undefined; configRow?: string | null | undefined; configData?: Record<string, never> | null | undefined; result?: { images?: { digests?: string[] | undefined; id?: string | undefined; }[] | undefined; configVersion?: number | undefined; message?: string | undefined; } | null | undefined; createdTime: string; startTime?: string | null | undefined; endTime?: string | null | undefined; delayedStartTime?: string | null | undefined; durationSeconds?: number | null | undefined; isFinished: boolean; url: string; variableValuesId?: string | null | undefined; variableValuesData?: { values?: { name?: string | undefined; value?: string | undefined; }[] | undefined; } | null | undefined; backend?: { type?: string | undefined; containerType?: string | undefined; context?: string | undefined; } | null | undefined; metrics?: { storage?: { inputTablesBytesSum?: number | undefined; outputTablesBytesSum?: number | undefined; } | undefined; backend?: { type?: string | undefined; containerType?: string | undefined; context?: string | undefined; } | undefined; } | null | undefined; type?: "standard" | "container" | "phaseContainer" | "orchestrationContainer" | "retryContainer" | undefined; orchestrationTaskId?: string | null | undefined; previousJobId?: string | null | undefined; onlyOrchestrationTaskIds?: string[] | null | undefined; onlyFlowTaskIds?: string[] | null | undefined; }[] | undefined; }[]>`
+- `api.queue.searchJobs(query?: { id?: string[] | undefined; runId?: string[] | undefined; branchId?: string[] | undefined; tokenId?: string[] | undefined; tokenDescription?: string[] | undefined; componentId?: string[] | undefined; component?: string[] | undefined; configId?: string[] | undefined; config?: string[] | undefined; configRowIds?: string[] | undefined; mode?: ("run" | "debug")[] | undefined; status?: ("error" | "success" | "warning" | "created" | "waiting" | "processing" | "terminating" | "terminated" | "cancelled")[] | undefined; type?: "standard" | "container" | "phaseContainer" | "orchestrationContainer" | "retryContainer" | undefined; componentProps?: { type?: string | undefined; } | undefined; createdTimeFrom?: string | undefined; createdTimeTo?: string | undefined; startTimeFrom?: string | undefined; startTimeTo?: string | undefined; endTimeFrom?: string | undefined; endTimeTo?: string | undefined; durationSecondsFrom?: number | undefined; durationSecondsTo?: number | undefined; offset?: number | undefined; limit?: number | undefined; sortBy?: "projectId" | "branchId" | "runId" | "componentId" | "configId" | "id" | "tokenDescription" | "status" | "createdTime" | "durationSeconds" | "startTime" | "endTime" | "updatedTime" | undefined; sortOrder?: "asc" | "desc" | undefined; parentRunId?: string | undefined; } | undefined, signal?: AbortSignal | undefined): Promise<{ id: string; runId: string; branchId?: string | undefined; project: { id: string; }; token: { id?: string | undefined; description?: string | undefined; }; status: "error" | "success" | "warning" | "created" | "waiting" | "processing" | "terminating" | "terminated" | "cancelled"; desiredStatus?: "processing" | "terminating" | null | undefined; component: string; mode: "run" | "debug"; tag?: string | null | undefined; config?: string | null | undefined; configRow?: string | null | undefined; configData?: Record<string, never> | null | undefined; result?: { images?: { digests?: string[] | undefined; id?: string | undefined; }[] | undefined; configVersion?: number | undefined; message?: string | undefined; } | null | undefined; createdTime: string; startTime?: string | null | undefined; endTime?: string | null | undefined; delayedStartTime?: string | null | undefined; durationSeconds?: number | null | undefined; isFinished: boolean; url: string; variableValuesId?: string | null | undefined; variableValuesData?: { values?: { name?: string | undefined; value?: string | undefined; }[] | undefined; } | null | undefined; backend?: { type?: string | undefined; containerType?: string | undefined; context?: string | undefined; } | null | undefined; metrics?: { storage?: { inputTablesBytesSum?: number | undefined; outputTablesBytesSum?: number | undefined; } | undefined; backend?: { type?: string | undefined; containerType?: string | undefined; context?: string | undefined; } | undefined; } | null | undefined; type?: "standard" | "container" | "phaseContainer" | "orchestrationContainer" | "retryContainer" | undefined; orchestrationTaskId?: string | null | undefined; previousJobId?: string | null | undefined; onlyOrchestrationTaskIds?: string[] | null | undefined; onlyFlowTaskIds?: string[] | null | undefined; }[]>`

package/surface/scheduler.md

@@ -10,4 +10,5 @@ Part of the [`@keboola/api-client` surface index](../API-SURFACE.md).
 - `api.scheduler.deleteSchedulesForConfigurations(configurationIds: string[], signal?: AbortSignal | undefined): Promise<void>`
 - `api.scheduler.getSchedule(scheduleId: string, signal?: AbortSignal | undefined): Promise<{ id: string; tokenId: string; configurationId: string; configurationVersionId: string; schedule: { cronTab: string; timezone: string; state: "enabled" | "disabled"; }; target: { componentId: string; configurationId: string; mode: string; tag: string; }; executions: { jobId: string; executionTime: string; }[]; }>`
 - `api.scheduler.getSchedules(query?: { componentId?: string | undefined; configurationId?: string | undefined; } | undefined, signal?: AbortSignal | undefined): Promise<{ id: string; tokenId: string; configurationId: string; configurationVersionId: string; schedule: { cronTab: string; timezone: string; state: "enabled" | "disabled"; }; target: { componentId: string; configurationId: string; mode: string; tag: string; }; executions: { jobId: string; executionTime: string; }[]; }[]>`
+- `api.scheduler.healthCheck(signal?: AbortSignal | undefined): Promise<unknown>`
 - `api.scheduler.refreshScheduleToken(scheduleId: string, signal?: AbortSignal | undefined): Promise<void>`