compass.pipeline.collection.persistence.build_collection_manifest#

build_collection_manifest(tech, jurisdictions, time_start_utc, num_jurisdictions_searched)[source]#

Build the serialized collection manifest payload

Parameters:
  • tech (str) – Technology specified in the pipeline request, included in the manifest for compatibility validation when loading.

  • jurisdictions (list) – List of serialized collection metadata for each jurisdiction, including jurisdiction identifiers and the persisted document records.

  • time_start_utc (datetime.datetime) – UTC datetime when the collection process started, used to calculate elapsed time for the manifest metadata.

  • num_jurisdictions_searched (int) – Number of jurisdictions that were searched during the collection process, included in the manifest for informational purposes.

Returns:

dict – Collection manifest as a dictionary, ready to be serialized and written to disk.