julee.domain.models.assembly
============================

.. py:module:: julee.domain.models.assembly

.. autoapi-nested-parse::

   Assembly domain package for the Capture, Extract, Assemble, Publish workflow.

   This package contains the Assembly domain object that represents assembly
   processes in the CEAP workflow.

   Assembly represents a specific instance of assembling a document using an
   AssemblySpecification, linking an input document with the specification and
   producing a single assembled document as output.



Submodules
----------

.. toctree::
   :maxdepth: 1

   /autoapi/julee/domain/models/assembly/assembly/index


Classes
-------

.. autoapisummary::

   julee.domain.models.assembly.Assembly
   julee.domain.models.assembly.AssemblyStatus


Package Contents
----------------

.. py:class:: Assembly(/, **data)

   Bases: :py:obj:`pydantic.BaseModel`


   Assembly process that links a specification with input document and
   produces an assembled document.

   An Assembly represents a specific instance of the document assembly
   process. It connects an AssemblySpecification (which defines how to
   assemble) with an input Document (what to assemble from) and produces
   a single assembled document as output.


   .. py:method:: assembled_document_id_must_not_be_empty_if_provided(v)
      :classmethod:



   .. py:method:: assembly_id_must_not_be_empty(v)
      :classmethod:



   .. py:method:: assembly_specification_id_must_not_be_empty(v)
      :classmethod:



   .. py:method:: input_document_id_must_not_be_empty(v)
      :classmethod:



   .. py:method:: workflow_id_must_not_be_empty(v)
      :classmethod:



   .. py:attribute:: assembled_document_id
      :type:  str | None
      :value: None



   .. py:attribute:: assembly_id
      :type:  str
      :value: None



   .. py:attribute:: assembly_specification_id
      :type:  str
      :value: None



   .. py:attribute:: created_at
      :type:  datetime.datetime | None
      :value: None



   .. py:attribute:: input_document_id
      :type:  str
      :value: None



   .. py:attribute:: status
      :type:  AssemblyStatus


   .. py:attribute:: updated_at
      :type:  datetime.datetime | None
      :value: None



   .. py:attribute:: workflow_id
      :type:  str
      :value: None



.. py:class:: AssemblyStatus

   Bases: :py:obj:`str`, :py:obj:`enum.Enum`


   Status of an assembly process.


   .. py:attribute:: CANCELLED
      :value: 'cancelled'



   .. py:attribute:: COMPLETED
      :value: 'completed'



   .. py:attribute:: FAILED
      :value: 'failed'



   .. py:attribute:: IN_PROGRESS
      :value: 'in_progress'



   .. py:attribute:: PENDING
      :value: 'pending'