HarvestApi

public interface HarvestApi implements WithApiKey

Harvest related operations

Functions

deleteHarvestSource

abstract Flow<DgfrCallState<HarvestSource>> deleteHarvestSource(String ident)

deleteUnscheduleHarvestSource

abstract Flow<DgfrCallState<HarvestSource>> deleteUnscheduleHarvestSource(String ident)

Unschedule an harvest source

getHarvestBackends

abstract Flow<DgfrCallState<HarvestBackend>> getHarvestBackends()

List all available harvest backends

getHarvestJob

abstract Flow<DgfrCallState<HarvestJobPage>> getHarvestJob(String ident, Integer page, Integer pageSize)

List all jobs for a given source

getHarvestSource

abstract Flow<DgfrCallState<HarvestSource>> getHarvestSource(String ident)

Get a single source given an ID or a slug

getListHarvesterApi

abstract Flow<DgfrCallState<List<String>>> getListHarvesterApi()

List all available harvesters

getListHarvestJobs

abstract Flow<DgfrCallState<HarvestJob>> getListHarvestJobs(String ident, Integer page, Integer pageSize)

List all jobs for a given source

getListHarvestSources

abstract Flow<DgfrCallState<List<HarvestSourcePage>>> getListHarvestSources(Integer page, Integer pageSize, String owner, Boolean deleted)

List all harvest sources

getPreviewHarvestSource

abstract Flow<DgfrCallState<HarvestJobPreview>> getPreviewHarvestSource(String ident)

Preview a single harvest source given an ID or a slug

postCreateHarvestSource

abstract Flow<DgfrCallState<HarvestSource>> postCreateHarvestSource(HarvestSource payload)

Create a new harvest source

postPreviewHarvestSourceConfig

abstract Flow<DgfrCallState<HarvestJobPreview>> postPreviewHarvestSourceConfig(HarvestSource payload)

Preview an harvesting from a source created with the given payload

postScheduleHarvestSource

abstract Flow<DgfrCallState<HarvestSource>> postScheduleHarvestSource(String ident, String payload)

Schedule an harvest source

postValidateHarvestSource

abstract Flow<DgfrCallState<HarvestSource>> postValidateHarvestSource(String ident, HarvestSourceValidation payload)

Validate or reject an harvest source

putUpdateHarvestSource

abstract Flow<DgfrCallState<HarvestSource>> putUpdateHarvestSource(String ident, HarvestSource payload)

Update a harvest source

setApiKey

abstract Unit setApiKey(String apiKey)

Inheritors

DgfrService