.. Adapted from https://stackoverflow.com/a/62613202

flexmeasures.data.services.automations
======================================





.. automodule:: flexmeasures.data.services.automations
  
   
   
   

   
   
   .. rubric:: Functions

   
   .. autofunction::
      automation_id_of_job
   .. autofunction::
      check_upstream_runs
   .. autofunction::
      claim_due_automation_run
   .. autofunction::
      claim_existing_automation_run
   .. autofunction::
      collect_schedule_output_sensors
   .. autofunction::
      collect_sensors
   .. autofunction::
      create_automation
   .. autofunction::
      delete_automation
   .. autofunction::
      describe_cronstr
   .. autofunction::
      dispatch_automation_run
   .. autofunction::
      ensure_automation_run_job_intents
   .. autofunction::
      errors_reported_for
   .. autofunction::
      floor_to_minute
   .. autofunction::
      floor_to_resolution
   .. autofunction::
      get_ascendant_automations
   .. autofunction::
      get_asset_automations_job_stats
   .. autofunction::
      get_automation_job_stats
   .. autofunction::
      get_automation_last_run
   .. autofunction::
      get_automation_run_stats
   .. autofunction::
      get_automation_sensors
   .. autofunction::
      get_automations_feeding_sensor
   .. autofunction::
      get_automations_in_scope
   .. autofunction::
      get_automations_involving_sensor
   .. autofunction::
      get_automations_waiting_for
   .. autofunction::
      get_dependent_automations
   .. autofunction::
      get_dispatchable_automation_runs
   .. autofunction::
      get_due_automations
   .. autofunction::
      get_forecast_output_sensor
   .. autofunction::
      get_latest_scheduled_run
   .. autofunction::
      get_next_scheduled_run
   .. autofunction::
      get_upstream_due_at
   .. autofunction::
      mark_automation_job_queued
   .. autofunction::
      mark_automation_run_dispatch_failed
   .. autofunction::
      mark_automation_run_dispatch_queued
   .. autofunction::
      pin_automation_run_effective_start
   .. autofunction::
      plan_automation_chain
   .. autofunction::
      prepare_report_parameters
   .. autofunction::
      prepare_schedule_trigger_message
   .. autofunction::
      reconcile_automation_job_intent
   .. autofunction::
      reconcile_unfinished_automation_jobs
   .. autofunction::
      record_automation_job_failed
   .. autofunction::
      record_automation_job_started
   .. autofunction::
      record_automation_job_succeeded
   .. autofunction::
      record_automation_run
   .. autofunction::
      record_automation_run_jobs
   .. autofunction::
      record_outcome_on_automation_run
   .. autofunction::
      refuse_fields_a_schedule_automation_cannot_use
   .. autofunction::
      refuse_fixed_moments
   .. autofunction::
      release_automation_runs_waiting_for
   .. autofunction::
      release_waiting_automation_run
   .. autofunction::
      renew_automation_run_claim
   .. autofunction::
      resolve_automation_sensors
   .. autofunction::
      resolve_automation_window
   .. autofunction::
      resolve_schedule_automation_sensors
   .. autofunction::
      resolve_schedule_generator
   .. autofunction::
      run_automation
   .. autofunction::
      run_automation_chain
   .. autofunction::
      run_automation_with_ascendants
   .. autofunction::
      sensors_automation_job_may_record_on
   .. autofunction::
      serialize_automation_dependencies
   .. autofunction::
      serialize_automation_run
   .. autofunction::
      set_automation_dependencies
   .. autofunction::
      update_automation
   .. autofunction::
      validate_automation_dependencies
   .. autofunction::
      validate_automation_output_scope
   .. autofunction::
      validate_automation_window
   .. autofunction::
      validate_offset_chain
   
   

   
   
   .. rubric:: Classes

        
   .. autoclass:: ClaimedAutomationRun
      :members:
      :special-members: __init__
      :private-members:     
   .. autoclass:: DueAutomation
      :members:
      :special-members: __init__
      :private-members:
   
   

   
   
   .. rubric:: Exceptions
      
   
   .. autoexception::
      AutomationRunClaimError
   .. autoexception::
      AutomationRunClaimLost
   .. autoexception::
      AutomationRunPlanChanged
   .. autoexception::
      AutomationSensorsUnknown
   .. autoexception::
      RecurringAutomationFixesAMoment