epicsarchiver_mgmt.commands.basic_commands
==========================================

.. py:module:: epicsarchiver_mgmt.commands.basic_commands

.. autoapi-nested-parse::

   Basic commands to modify PVs in the archiver.



Attributes
----------

.. autoapisummary::

   epicsarchiver_mgmt.commands.basic_commands.LOG
   epicsarchiver_mgmt.commands.basic_commands.PAUSE_EXPECTED_STATUS


Classes
-------

.. autoapisummary::

   epicsarchiver_mgmt.commands.basic_commands.BasicCommand
   epicsarchiver_mgmt.commands.basic_commands.PauseCommand
   epicsarchiver_mgmt.commands.basic_commands.ResumeCommand
   epicsarchiver_mgmt.commands.basic_commands.DeleteCommand
   epicsarchiver_mgmt.commands.basic_commands.AbortCommand


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

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

.. py:data:: PAUSE_EXPECTED_STATUS

.. py:class:: BasicCommand

   Basic command to modify PVs in the archiver.


   .. py:attribute:: command_name
      :type:  str


   .. py:attribute:: expected_statuses
      :type:  collections.abc.Sequence[epicsarchiver_mgmt.archiver.info.ArchivingStatus | None]


   .. py:attribute:: expected_operation_results
      :type:  dict[str, list[str]] | None
      :value: None



   .. py:method:: __call__(archiver: epicsarchiver_mgmt.archiver.mgmt.ArchiverMgmt, pv: str) -> epicsarchiver_mgmt.archiver.mgmt.OperationResult
      :abstractmethod:


      Command to execute.

      :param archiver: The archiver to use.
      :type archiver: ArchiverMgmt
      :param pv: The PV to modify.
      :type pv: str

      :returns: The result of the command.
      :rtype: OperationResult



   .. py:method:: run_command(archiver_fqdns: list[str], pvs: collections.abc.Sequence[str], *, skip_validation: bool = False) -> None

      Basic command to modify PVs in the archiver.

      :param archiver_fqdns: The urls of the archiver.
      :type archiver_fqdns: list[str]
      :param pvs: The PVs to change.
      :type pvs: list[str]
      :param skip_validation: Whether to skip validation of the PVs status.
      :type skip_validation: bool

      :raises RequestHTTPError: If there is an error changing the PVs.



.. py:class:: PauseCommand

   Bases: :py:obj:`BasicCommand`


   Pause command to modify PVs in the archiver.


   .. py:method:: __call__(archiver: epicsarchiver_mgmt.archiver.mgmt.ArchiverMgmt, pv: str) -> epicsarchiver_mgmt.archiver.mgmt.OperationResult

      Pause PV in the archiver.

      :param archiver: The archiver to use.
      :type archiver: ArchiverMgmt
      :param pv: The PV to pause.
      :type pv: str

      :returns: The result of the command.
      :rtype: OperationResult



.. py:class:: ResumeCommand

   Bases: :py:obj:`BasicCommand`


   Resume command to modify PVs in the archiver.


   .. py:method:: __call__(archiver: epicsarchiver_mgmt.archiver.mgmt.ArchiverMgmt, pv: str) -> epicsarchiver_mgmt.archiver.mgmt.OperationResult

      Resume PV in the archiver.

      :param archiver: The archiver to use.
      :type archiver: ArchiverMgmt
      :param pv: The PV to resume.
      :type pv: str

      :returns: The result of the command.
      :rtype: OperationResult



.. py:class:: DeleteCommand

   Bases: :py:obj:`BasicCommand`


   Delete command to modify PVs in the archiver.


   .. py:method:: __call__(archiver: epicsarchiver_mgmt.archiver.mgmt.ArchiverMgmt, pv: str) -> epicsarchiver_mgmt.archiver.mgmt.OperationResult

      Delete PV in the archiver.

      :param archiver: The archiver to use.
      :type archiver: ArchiverMgmt
      :param pv: The PV to delete.
      :type pv: str

      :returns: The result of the command.
      :rtype: OperationResult



.. py:class:: AbortCommand

   Bases: :py:obj:`BasicCommand`


   Abort command to modify PVs in the archiver.


   .. py:method:: __call__(archiver: epicsarchiver_mgmt.archiver.mgmt.ArchiverMgmt, pv: str) -> epicsarchiver_mgmt.archiver.mgmt.OperationResult

      Abort archiving PV in the archiver.

      :param archiver: The archiver to use.
      :type archiver: ArchiverMgmt
      :param pv: The PV to abort.
      :type pv: str

      :returns: The result of the command.
      :rtype: OperationResult