cyclonedx.model.service
=======================

.. py:module:: cyclonedx.model.service

.. autoapi-nested-parse::

   This set of classes represents the data that is possible about known Services.

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



Classes
-------

.. autoapisummary::

   cyclonedx.model.service.Service


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

.. py:class:: Service

   Bases: :py:obj:`cyclonedx.model.dependency.Dependable`


   Class that models the `service` complex type in the CycloneDX schema.

   .. note::
       See the CycloneDX schema: https://cyclonedx.org/docs/1.7/xml/#type_service


   .. py:attribute:: name
      :type:  str


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


   .. py:attribute:: provider
      :type:  Optional[cyclonedx.model.contact.OrganizationalEntity]


   .. py:attribute:: group
      :type:  Optional[str]


   .. py:attribute:: version
      :type:  Optional[str]


   .. py:attribute:: description
      :type:  Optional[str]


   .. py:attribute:: endpoints
      :type:  SortedSet[XsUri]


   .. py:attribute:: authenticated
      :type:  Optional[bool]


   .. py:attribute:: x_trust_boundary
      :type:  Optional[bool]


   .. py:attribute:: data
      :type:  SortedSet[DataClassification]


   .. py:attribute:: licenses
      :type:  cyclonedx.model.license.LicenseRepository


   .. py:attribute:: external_references
      :type:  SortedSet[ExternalReference]


   .. py:attribute:: properties
      :type:  SortedSet[Property]


   .. py:attribute:: services
      :type:  SortedSet[Service]


   .. py:attribute:: release_notes
      :type:  Optional[cyclonedx.model.release_note.ReleaseNotes]