# 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.

#### `__init__() -> None`

Initialize the dumper.

### `OAIHarvesterAggregate`

Bases: `BaseAggregate`

An aggregate of information about an OAI-PMH harvester.

#### `model_cls = OAIHarvesterAggregateModel`

The model class for the request.

#### `dumper = HarvesterDumper()`

Search dumper with configured extensions.

#### `index = IndexField('oai-harvester-oai-harvester-v1.0.0')`

The search engine index to use.

#### `id = ModelField('id', dump_type=str)`

The ID of the harvester.

#### `base_url = ModelField('base_url', dump_type=str)`

The base URL of the OAI-PMH service.

#### `name = ModelField('name', dump_type=str)`

The name of the harvester.

#### `comment = ModelField('comment', dump_type=str)`

Comment.

#### `metadata_prefix = ModelField('metadata_prefix', dump_type=str)`

The metadata prefix to harvest.

#### `setspec = ModelField('setspec', dump_type=str)`

The set specifications to harvest.

#### `loader = ModelField('loader', dump_type=str)`

The definition of the loader.

#### `transformers = ModelField('transformers', dump_type=list)`

The list of transformers.

#### `writers = ModelField('writers', dump_type=list)`

The list of writers.

#### `harvest_managers = ModelField('harvest_managers', dump_type=list)`

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`

Create a new OAI harvester and store it in the database.

#### `delete(force: bool = False) -> OAIHarvesterAggregate`

Delete the harvester.

#### `get_record(id_: UUID | str, with_deleted: bool = False) -> OAIHarvesterAggregate`

Get the harvester via the specified ID (harvesters are never soft deleted).
