Logo
Type aliases

ProgressEvent

ProgressEvent = object

Defined in: packages/cloud/src/client/types.gen.ts:7084

Event for tracking progress of operations in workflows.

Properties

timestamp?

optional timestamp: string

Defined in: packages/cloud/src/client/types.gen.ts:7085


id?

optional id: string

Defined in: packages/cloud/src/client/types.gen.ts:7089

The ID of the event


group_id?

optional group_id: string

Defined in: packages/cloud/src/client/types.gen.ts:7093

The ID of the group this event belongs to


type?

optional type: "progress"

Defined in: packages/cloud/src/client/types.gen.ts:7094


variant

variant: ReportEventType

Defined in: packages/cloud/src/client/types.gen.ts:7095


msg

msg: string

Defined in: packages/cloud/src/client/types.gen.ts:7099

The message to display to the user


progress?

optional progress: number | null

Defined in: packages/cloud/src/client/types.gen.ts:7103

Progress value between 0-1 if available


status?

optional status: "pending" | "in_progress" | "completed" | "error"

Defined in: packages/cloud/src/client/types.gen.ts:7107

Current status of the operation


extra_detail?

optional extra_detail: {[key: string]: unknown; } | null

Defined in: packages/cloud/src/client/types.gen.ts:7111

Any extra details to display to the user