UNPKG

@prefecthq/prefect-ui-library

Version:

This library is the Vue and Typescript component library for [Prefect 2](https://github.com/PrefectHQ/prefect) and [Prefect Cloud 2](https://www.prefect.io/cloud/). _The components and utilities in this project are not meant to be used independently_.

37 lines (36 loc) 2.18 kB
import { RunGraphData } from '@prefecthq/graphs'; import { StateUpdate } from '../models'; import { OrchestrationResult } from '../models/api/OrchestrationResult'; import { FlowRunsFilter, FlowRunsHistoryFilter, FlowRunsPaginationFilter } from '../models/Filters'; import { FlowRun } from '../models/FlowRun'; import { FlowRunInputKeyset } from '../models/FlowRunInputKeyset'; import { Paginated } from '../models/pagination'; import { RunHistory } from '../models/RunHistory'; import { SchemaV2, SchemaValuesV2 } from '../schemas'; import { WorkspaceApi } from '../services/WorkspaceApi'; import { Schema, SchemaValues } from '../types/schemas'; type GetFlowRunGraphOptions = { nestedTaskRunGraphs: boolean; }; export declare class WorkspaceFlowRunsApi extends WorkspaceApi { protected routePrefix: string; private readonly batcher; getFlowRun(id: string): Promise<FlowRun>; getFlowRuns(filter?: FlowRunsFilter): Promise<FlowRun[]>; getFlowRunsPaginated(filter?: FlowRunsPaginationFilter): Promise<Paginated<FlowRun>>; getFlowRunsCount(filter?: FlowRunsFilter): Promise<number>; getFlowRunsHistory(filter: FlowRunsHistoryFilter): Promise<RunHistory[]>; getFlowRunsAverageLateness(filter: FlowRunsFilter): Promise<number | null>; getFlowRunsGraph(id: string, { nestedTaskRunGraphs }: GetFlowRunGraphOptions): Promise<RunGraphData>; getFlowRunInputDescription(id: string, keyset: FlowRunInputKeyset | undefined): Promise<string | null>; getFlowRunInputSchema(id: string, keyset: FlowRunInputKeyset): Promise<Schema>; getFlowRunInputSchemaV2(id: string, keyset: FlowRunInputKeyset): Promise<SchemaV2>; retryFlowRun(id: string): Promise<void>; setFlowRunState(id: string, body: StateUpdate, force?: boolean): Promise<void>; resumeFlowRun(id: string, values?: SchemaValues): Promise<OrchestrationResult>; resumeFlowRunV2(id: string, values: SchemaValuesV2): Promise<OrchestrationResult>; deleteFlowRun(flowRunId: string): Promise<void>; downloadFlowRunLogs(flowRunId: string, flowRunName: string | null): Promise<void>; getFlowRunJobConfig(flowRunId: string): Promise<Record<string, unknown>>; } export {};