@terascope/job-components / interfaces/misc / RouteSenderAPI
Interface: RouteSenderAPI
Defined in: job-components/src/interfaces/misc.ts:32
Used for sending data to particular index/topic/file/table in a storage system. This is used by the routed sender in the standard-assets
Methods
send()
send(
records):Promise<number>
Defined in: job-components/src/interfaces/misc.ts:38
Sends the records to the respective storage backend
Parameters
| Parameter | Type |
|---|---|
records | Iterable<DataEntity<Record<string, any>, _DataEntityMetadata<Record<string, any>>>> |
Returns
Promise<number>
the number of affected records/rows
verify()?
optionalverify(route?):Promise<void>
Defined in: job-components/src/interfaces/misc.ts:46
This is used to verify and create an resources required for this particular route
This is optional to implement
Parameters
| Parameter | Type |
|---|---|
route? | string |
Returns
Promise<void>