oarepo_oaipmh_harvester.oai_harvester.api
oarepo_oaipmh_harvester.oai_harvester.api
Record API level classes for OAI-PMH Harvester.
HarvesterDumper
Bases: SearchDumper
Search dumper with configured extensions.
Source code in oarepo_oaipmh_harvester/oai_harvester/api.py
OAIHarvesterAggregate
Bases: BaseAggregate
An aggregate of information about an OAI-PMH harvester.
Source code in oarepo_oaipmh_harvester/oai_harvester/api.py
57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 | |
model_cls = OAIHarvesterAggregateModel
class-attribute
instance-attribute
The model class for the request.
dumper = HarvesterDumper()
class-attribute
instance-attribute
Search dumper with configured extensions.
index = IndexField('oai-harvester-oai-harvester-v1.0.0')
class-attribute
instance-attribute
The search engine index to use.
id = ModelField('id', dump_type=str)
class-attribute
instance-attribute
The ID of the harvester.
base_url = ModelField('base_url', dump_type=str)
class-attribute
instance-attribute
The base URL of the OAI-PMH service.
name = ModelField('name', dump_type=str)
class-attribute
instance-attribute
The name of the harvester.
comment = ModelField('comment', dump_type=str)
class-attribute
instance-attribute
Comment.
metadata_prefix = ModelField('metadata_prefix', dump_type=str)
class-attribute
instance-attribute
The metadata prefix to harvest.
setspec = ModelField('setspec', dump_type=str)
class-attribute
instance-attribute
The set specifications to harvest.
loader = ModelField('loader', dump_type=str)
class-attribute
instance-attribute
The definition of the loader.
transformers = ModelField('transformers', dump_type=list)
class-attribute
instance-attribute
The list of transformers.
writers = ModelField('writers', dump_type=list)
class-attribute
instance-attribute
The list of writers.
harvest_managers = ModelField('harvest_managers', dump_type=list)
class-attribute
instance-attribute
The list of harvest managers. Each item is a dict with 'user' key with user ID.
create(data: dict, id_: UUID | None = None, **kwargs: Any) -> OAIHarvesterAggregate
classmethod
Create a new OAI harvester and store it in the database.
Source code in oarepo_oaipmh_harvester/oai_harvester/api.py
delete(force: bool = False) -> OAIHarvesterAggregate
Delete the harvester.
Source code in oarepo_oaipmh_harvester/oai_harvester/api.py
get_record(id_: UUID | str, with_deleted: bool = False) -> OAIHarvesterAggregate
classmethod
Get the harvester via the specified ID (harvesters are never soft deleted).