@oneplatform/plugin-sdk

@oneplatform/plugin-sdk / ConnectorHandle

Interface: ConnectorHandle¶

Defined in: packages/plugin-sdk/src/types/connector.ts:16

Properties¶

connectionId¶

connectionId: string

Defined in: packages/plugin-sdk/src/types/connector.ts:23

Opaque identifier for this active connection, assigned by the plugin. Used to correlate fetchBatch and disconnect calls to the same connection. Must be a string. The platform stores this between fetchBatch calls to support resumable ingestion.

metadata¶

metadata: Record\<string, unknown>

Defined in: packages/plugin-sdk/src/types/connector.ts:30

Plugin-managed connection state. May include auth tokens, base URLs, or other values needed by fetchBatch and disconnect. Must be JSON-serializable (the platform may checkpoint this between calls).