edeposit.amqp.aleph_link_export
stable
  • link_export submodule
  • request_database submodule
  • shelvedb submodule
  • settings submodule
  • Request structures
  • Response structures
edeposit.amqp.aleph_link_export
  • Docs »
  • Request structures
  • Edit on GitHub

Request structures¶

class aleph_link_export.structures.requests.LinkDescription¶

Bases: aleph_link_export.structures.requests.LinkDescription

Optional structure, which can be used instead of string to describe the format of the url.

url¶

str – URL of the document.

format¶

str – Format of the document.

Create new instance of LinkDescription(url, format)

to_dict_xml()¶

Serialize the object to dictionary, which may be later used for conversion to XML.

Retruns:
OrderedDict: Itself as ordered dict.
class aleph_link_export.structures.requests.LinkUpdateRequest¶

Bases: aleph_link_export.structures.requests.LinkUpdateRequest

Request to update metadata in Aleph.

session_id¶

str – Session_id for this request. Used to pair requests with responses.

uuid¶

str – UUID for the doc_number you wish to update.

doc_number¶

str – Document number of the document you wish to update. If there is a summary aleph record for this document at Aleph please send a doc_number of this summary aleph record.

document_urls¶

list – Newly added public URL to the storage / whatever subsystem. List of strings or LinkDescription.

kramerius_url¶

str, default None – Newly added URL to the Kramerius subsystem.

urn_nbn¶

str, default None – Optional newly added URN:NBN for the record.

to_dict_xml()¶

Convert the structure to nested ordered-dicts, which are later used for construction of the XML.

Returns:Itself as ordered dicts.
Return type:OrderedDict
class aleph_link_export.structures.requests.StatusRequest¶

Bases: aleph_link_export.structures.requests.StatusRequest

This structure is used to wake the daemon to go and check whether the files on the disc changed or not.

Create new instance of StatusRequest()

Next Previous

© Copyright 2015 E-deposit team. Revision 5b6068a9.

Built with Sphinx using a theme provided by Read the Docs.
Read the Docs v: stable
Versions
latest
stable
Downloads
htmlzip
On Read the Docs
Project Home
Builds

Free document hosting provided by Read the Docs.