Package com.collibra.catalog.sampler.api
Interface DataSamplerApi
public interface DataSamplerApi
-
Method Summary
Modifier and TypeMethodDescriptioncollectAndStoreSamples
(UUID assetId, Instant startTime) Creates a request to collect sample data from an Edge data source for the asset with the specified ID and temporarily makes it available in the Edge cache.readSamples
(ReadSamplesRequest readSamplesRequest, Duration timeout) Reads the available sample data from the Collibra cloud repository or Edge cache depending on how the data is collected.
-
Method Details
-
collectAndStoreSamples
Creates a request to collect sample data from an Edge data source for the asset with the specified ID and temporarily makes it available in the Edge cache.- Parameters:
assetId
- asset identifierstartTime
- reference to starting point- Returns:
- Response containing job ID which is running the fetching samples process and flag indicating if the new job was started to fetch samples or there was already one which existed before.
-
readSamples
CompletionStage<ReadSamplesResponse> readSamples(ReadSamplesRequest readSamplesRequest, Duration timeout) Reads the available sample data from the Collibra cloud repository or Edge cache depending on how the data is collected.- Parameters:
readSamplesRequest
- request parameters(assetId[required], columnLimit[optional, default 0], columnOffset[optional, default 0]timeout
- max duration allowed reading- Returns:
- samples in paginated form
-