cyclonedx.model.citation
========================

.. py:module:: cyclonedx.model.citation

.. autoapi-nested-parse::

   This set of classes represents the data about Citations.

   .. note::
       Introduced in CycloneDX v1.7

   .. note::
       See the CycloneDX Schema extension definition https://cyclonedx.org/docs/1.7/xml/#type_citationType



Classes
-------

.. autoapisummary::

   cyclonedx.model.citation.Citation


Module Contents
---------------

.. py:class:: Citation(*, timestamp: datetime.datetime, bom_ref: Optional[Union[str, cyclonedx.model.bom_ref.BomRef]] = None, pointers: Optional[collections.abc.Iterable[str]] = None, expressions: Optional[collections.abc.Iterable[str]] = None, attributed_to: Optional[Union[str, cyclonedx.model.bom_ref.BomRef]] = None, process: Optional[Union[str, cyclonedx.model.bom_ref.BomRef]] = None, note: Optional[str] = None)

   Details a specific attribution of data within the BOM to a contributing entity or process.

   Exactly one of `pointers` or `expressions` must be provided.
   At least one of `attributed_to` or `process` must be provided.

   .. note::
       Introduced in CycloneDX v1.7

   .. note::
       See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.7/xml/#type_citationType


   .. py:property:: pointers
      :type: SortedSet[str]


      One or more JSON Pointers (RFC 6901) identifying the BOM fields to which the attribution applies.
      Users of other serialization formats (e.g. XML) shall use the JSON Pointer format as well.

      Returns:
          Set of `str`



   .. py:property:: expressions
      :type: SortedSet[str]


      One or more path expressions used to locate values within a BOM.
      Use JSONPath for JSON and XPath for XML.

      Returns:
          Set of `str`



   .. py:property:: timestamp
      :type: datetime.datetime


      The date and time when the attribution was made or the information was supplied.

      Returns:
          `datetime`



   .. py:property:: attributed_to
      :type: Optional[cyclonedx.model.bom_ref.BomRef]


      The `bom-ref` of an object, such as a component, service, tool, organisational entity, or person
      that supplied the cited information.

      Returns:
          `BomRef` if set else `None`



   .. py:property:: process
      :type: Optional[cyclonedx.model.bom_ref.BomRef]


      The `bom-ref` to a process (such as a formula, workflow, task, or step) defined in the `formulation`
      section that executed or generated the attributed data.

      Returns:
          `BomRef` if set else `None`



   .. py:property:: note
      :type: Optional[str]


      A description or comment about the context or quality of the data attribution.

      Returns:
          `str` if set else `None`



   .. py:property:: bom_ref
      :type: cyclonedx.model.bom_ref.BomRef


      An optional identifier which can be used to reference the citation elsewhere in the BOM.
      Every bom-ref MUST be unique within the BOM.

      Returns:
          `BomRef`