pipeline.src.entities.alerts
============================

.. py:module:: pipeline.src.entities.alerts


Classes
-------

.. autoapisummary::

   pipeline.src.entities.alerts.AlertType
   pipeline.src.entities.alerts.GearSpecification
   pipeline.src.entities.alerts.SpeciesSpecification
   pipeline.src.entities.alerts.AdministrativeAreaType
   pipeline.src.entities.alerts.AreasTableMetadata
   pipeline.src.entities.alerts.AdminAreasSpecification
   pipeline.src.entities.alerts.AdminAreasSpecWithTable
   pipeline.src.entities.alerts.RegulatoryAreaSpecification
   pipeline.src.entities.alerts.PositionAlertSpecification


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

.. py:class:: AlertType(*args, **kwds)

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


   Create a collection of name/value pairs.

   Example enumeration:

   >>> class Color(Enum):
   ...     RED = 1
   ...     BLUE = 2
   ...     GREEN = 3

   Access them by:

   - attribute access::

   >>> Color.RED
   <Color.RED: 1>

   - value lookup:

   >>> Color(1)
   <Color.RED: 1>

   - name lookup:

   >>> Color['RED']
   <Color.RED: 1>

   Enumerations can be iterated over, and know how many members they have:

   >>> len(Color)
   3

   >>> list(Color)
   [<Color.RED: 1>, <Color.BLUE: 2>, <Color.GREEN: 3>]

   Methods can be added to enumerations, and members can have their own
   attributes -- see the documentation for details.


   .. py:attribute:: MISSING_DEP_ALERT
      :value: 'MISSING_DEP_ALERT'



   .. py:attribute:: MISSING_FAR_ALERT
      :value: 'MISSING_FAR_ALERT'



   .. py:attribute:: MISSING_FAR_48_HOURS_ALERT
      :value: 'MISSING_FAR_48_HOURS_ALERT'



   .. py:attribute:: SUSPICION_OF_UNDER_DECLARATION_ALERT
      :value: 'SUSPICION_OF_UNDER_DECLARATION_ALERT'



   .. py:attribute:: POSITION_ALERT
      :value: 'POSITION_ALERT'



.. py:class:: GearSpecification

   .. py:attribute:: gear
      :type:  str


   .. py:attribute:: minMesh
      :type:  float | None
      :value: None



   .. py:attribute:: maxMesh
      :type:  float | None
      :value: None



.. py:class:: SpeciesSpecification

   .. py:attribute:: species
      :type:  str


   .. py:attribute:: minWeight
      :type:  float | None
      :value: None



.. py:class:: AdministrativeAreaType(*args, **kwds)

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


   Create a collection of name/value pairs.

   Example enumeration:

   >>> class Color(Enum):
   ...     RED = 1
   ...     BLUE = 2
   ...     GREEN = 3

   Access them by:

   - attribute access::

   >>> Color.RED
   <Color.RED: 1>

   - value lookup:

   >>> Color(1)
   <Color.RED: 1>

   - name lookup:

   >>> Color['RED']
   <Color.RED: 1>

   Enumerations can be iterated over, and know how many members they have:

   >>> len(Color)
   3

   >>> list(Color)
   [<Color.RED: 1>, <Color.BLUE: 2>, <Color.GREEN: 3>]

   Methods can be added to enumerations, and members can have their own
   attributes -- see the documentation for details.


   .. py:attribute:: FAO_AREA
      :value: 'FAO_AREA'



   .. py:attribute:: EEZ_AREA
      :value: 'EEZ_AREA'



   .. py:attribute:: NEAFC_AREA
      :value: 'NEAFC_AREA'



   .. py:attribute:: DISTANCE_TO_SHORE
      :value: 'DISTANCE_TO_SHORE'



.. py:class:: AreasTableMetadata

   .. py:attribute:: table_name
      :type:  str


   .. py:attribute:: geometry_column
      :type:  str


   .. py:attribute:: filter_column
      :type:  str


.. py:class:: AdminAreasSpecification

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


   .. py:attribute:: areaType
      :type:  AdministrativeAreaType


   .. py:attribute:: areas
      :type:  List


.. py:class:: AdminAreasSpecWithTable

   .. py:attribute:: area_type
      :type:  AdministrativeAreaType


   .. py:attribute:: areas
      :type:  List


   .. py:attribute:: metadata
      :type:  AreasTableMetadata


   .. py:attribute:: table
      :type:  sqlalchemy.Table


.. py:class:: RegulatoryAreaSpecification

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


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



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



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



.. py:class:: PositionAlertSpecification

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


   .. py:attribute:: id
      :type:  int


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


   .. py:attribute:: description
      :type:  str


   .. py:attribute:: natinf_code
      :type:  int


   .. py:attribute:: threat
      :type:  str


   .. py:attribute:: threat_characterization
      :type:  str


   .. py:attribute:: is_activated
      :type:  bool


   .. py:attribute:: is_in_error
      :type:  bool


   .. py:attribute:: error_reason
      :type:  str | None


   .. py:attribute:: validity_start_datetime_utc
      :type:  datetime.datetime | None


   .. py:attribute:: validity_end_datetime_utc
      :type:  datetime.datetime | None


   .. py:attribute:: repeat_each_year
      :type:  bool


   .. py:attribute:: track_analysis_depth
      :type:  float


   .. py:attribute:: only_fishing_positions
      :type:  bool


   .. py:attribute:: gears
      :type:  List[GearSpecification] | None


   .. py:attribute:: species
      :type:  List[SpeciesSpecification] | None


   .. py:attribute:: species_catch_areas
      :type:  List[str] | None


   .. py:attribute:: administrative_areas
      :type:  List[AdminAreasSpecification] | None


   .. py:attribute:: regulatory_areas
      :type:  List[RegulatoryAreaSpecification] | None


   .. py:attribute:: min_depth
      :type:  float | None


   .. py:attribute:: flag_states_iso2
      :type:  List[str] | None


   .. py:attribute:: vessel_ids
      :type:  List[int] | None


   .. py:attribute:: district_codes
      :type:  List[str] | None


   .. py:attribute:: producer_organizations
      :type:  List[str] | None


   .. py:method:: model_post_init(__context)