Logo
Type aliases

ProgressEvent

ProgressEvent = object

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

Event for tracking progress of operations in workflows.

Properties

timestamp?

optional timestamp: string

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


id?

optional id: string

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

The ID of the event


group_id?

optional group_id: string

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

The ID of the group this event belongs to


type?

optional type: "progress"

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


variant

variant: ReportEventType

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


msg

msg: string

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

The message to display to the user


progress?

optional progress: number | null

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

Progress value between 0-1 if available


status?

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

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

Current status of the operation


extra_detail?

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

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

Any extra details to display to the user