epicsarchiver_mgmt.commands.change_parameter
============================================

.. py:module:: epicsarchiver_mgmt.commands.change_parameter

.. autoapi-nested-parse::

   Change the sampling method or sampling period of PVs in the archiver.



Attributes
----------

.. autoapisummary::

   epicsarchiver_mgmt.commands.change_parameter.LOG


Functions
---------

.. autoapisummary::

   epicsarchiver_mgmt.commands.change_parameter.sampling_period_from_statuses
   epicsarchiver_mgmt.commands.change_parameter.change_parameter


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

.. py:data:: LOG
   :type:  logging.Logger

.. py:function:: sampling_period_from_statuses(pv: str, pv_statuses: epicsarchiver_mgmt.archiver.info.InfoResultList) -> float

   Get the sampling period from the PV status.

   :param pv: The PV name.
   :type pv: str
   :param pv_statuses: The statuses of the PVs.
   :type pv_statuses: InfoResultList

   :returns: The sampling period of the PV.
   :rtype: float

   :raises ValueError: If the PV is not found in the provided statuses.


.. py:function:: change_parameter(archiver_fqdn: str, pvs: collections.abc.Sequence[str], sampling_method: epicsarchiver_mgmt.archiver.mgmt.SamplingMethod | None = None, sampling_period: float | None = None) -> None

   Change the sampling method or sampling period of PVs in the archiver.

   :param archiver_fqdn: The url of the archiver.
   :type archiver_fqdn: str
   :param pvs: The PVs to change type.
   :type pvs: list[str]
   :param sampling_method: The sampling method to use.
   :type sampling_method: str
   :param sampling_period: The sampling period to use.
   :type sampling_period: float

   :raises RequestHTTPError: If the request fails.