Package com.seeq.link.sdk.interfaces
Interface ConditionPullDatasourceConnection
- All Superinterfaces:
DatasourceConnectionV2
,IndexingDatasourceConnection
,PullDatasourceConnection
Implemented by connections that query their datasources for capsules (within conditions) on-demand when Seeq
requires data.
Threading considerations:
All methods may be called from different threads concurrently.
-
Method Summary
Modifier and TypeMethodDescriptiongetCapsules
(GetCapsulesParameters parameters) Queries the external system for the capsules in a condition.Methods inherited from interface com.seeq.link.sdk.interfaces.DatasourceConnectionV2
connect, destroy, disconnect, getDatasourceClass, getDatasourceId, getDatasourceName, initialize, monitor, saveConfig
Methods inherited from interface com.seeq.link.sdk.interfaces.IndexingDatasourceConnection
getConfiguration, index
Methods inherited from interface com.seeq.link.sdk.interfaces.PullDatasourceConnection
getMaxConcurrentRequests, getMaxResultsPerRequest
-
Method Details
-
getCapsules
Queries the external system for the capsules in a condition. Note that if this method is implemented,GetCapsulesParameters.setLastCertainKey(TimeInstant)
must be invoked ifGetCapsulesParameters.isLastCertainKeyRequested()
returnstrue
, or all capsules returned will appear uncertain in Seeq.- Parameters:
parameters
- AGetCapsulesParameters
object containing the parameters of the request. Consult the documentation for each field on that object for further information.- Returns:
- A stream used to retrieve the capsules. A stream is used so the connection author can avoid loading all capsules into memory, if the underlying datasource interface allows it. Streams can be created in a variety of ways, such as Guava's Streams.stream(iterable), Java's Stream.of(T... values), or Collection.stream().
- Throws:
Exception
- All exceptions will get caught and the text of the exception will be set as the user visible status.
-