TransferPlanStep
Defined in: src/transfers/TransferPlan.ts:12
Step inside a transfer plan.
Properties
Section titled “Properties”| Property | Type | Description | Defined in |
|---|---|---|---|
action | TransferPlanAction | Action the step would perform. | src/transfers/TransferPlan.ts:16 |
destination? | TransferEndpoint | Destination endpoint when the action writes data. | src/transfers/TransferPlan.ts:20 |
destructive? | boolean | Whether this step may remove or replace data. | src/transfers/TransferPlan.ts:24 |
expectedBytes? | number | Expected bytes affected by the step when known. | src/transfers/TransferPlan.ts:22 |
id | string | Stable step identifier within the plan. | src/transfers/TransferPlan.ts:14 |
metadata? | Record<string, unknown> | Caller-defined metadata retained for diagnostics. | src/transfers/TransferPlan.ts:28 |
reason? | string | Human-readable reason for planned or skipped work. | src/transfers/TransferPlan.ts:26 |
source? | TransferEndpoint | Source endpoint when the action reads data. | src/transfers/TransferPlan.ts:18 |