.. _f-azuretransferapi:

module ``remote.azure_transfer_api``
====================================





.. inheritance-diagram:: pyenbc.remote.azure_transfer_api


Short summary
+++++++++++++

module ``pyenbc.remote.azure_transfer_api``

API to move files





Classes
+++++++

+-------------------------------------------------------------------------------+---------------------------------------------------------+
| class                                                                         | truncated documentation                                 |
+===============================================================================+=========================================================+
| :class:`AzureTransferAPI <pyenbc.remote.azure_transfer_api.AzureTransferAPI>` | defines an API to transfer files over a remote location |
+-------------------------------------------------------------------------------+---------------------------------------------------------+










Methods
+++++++

+----------------------------------------------------------------------------------+--------------------------------------------------------+
| method                                                                           | truncated documentation                                |
+==================================================================================+========================================================+
| :py:meth:`__init__ <pyenbc.remote.azure_transfer_api.AzureTransferAPI.__init__>` |                                                        |
+----------------------------------------------------------------------------------+--------------------------------------------------------+
| :meth:`retrieve <pyenbc.remote.azure_transfer_api.AzureTransferAPI.retrieve>`    | retrieve data from path                                |
+----------------------------------------------------------------------------------+--------------------------------------------------------+
| :meth:`transfer <pyenbc.remote.azure_transfer_api.AzureTransferAPI.transfer>`    | we assume a data holds in memory, tansfer data to path |
+----------------------------------------------------------------------------------+--------------------------------------------------------+


Documentation
+++++++++++++

.. automodule:: pyenbc.remote.azure_transfer_api
    :members:
    :special-members: __init__
    :show-inheritance: