
.. _structure-manifest-files:

:index:`Manifest Files Structure`
---------------------------------

A ManifestFiles structure is returned from :meth:`~jetstream.sendinterface.SendInterface.getManifestFiles`.

.. glossary::
   :sorted:

   :index:`manifestId <pair: Manifest Files Structure; manifestId>`
      A manifest ID. Manifest IDs are returned from :meth:`~jetstream.sendinterface.SendInterface.createManifest`, and used in other methods to refer to a specific manifest.

   :index:`fileMappings <pair: Manifest Files Structure; fileMappings>`
      A list of :ref:`structure-file-mapping`.

.. _structure-file-mapping:

:index:`File Mapping Structure`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

A File Mapping structure is returned as part of the result from :meth:`~jetstream.sendinterface.SendInterface.getManifestFiles`.

.. glossary::
   :sorted:

   :index:`srcPath <pair: File Mapping Structure; srcPath>`
      A path to a file that has been added to a manifest. When added to a transfer, this file will be copied to a destination.

   :index:`destPath <pair: File Mapping Structure; destPath>`
      A path to which the file will be written at the destination.

   :index:`fileSize <pair: File Mapping Structure; fileSize>`
      The size, in bytes, of the file. May be 0 (zero) if this is an empty file or an empty directory.

   :index:`isEmptyDir <pair: File Mapping Structure; isEmptyDir>`
      If ``True``, indicates that a transfer will create an empty directory at the destination.

   :index:`modificationTime <pair: File Mapping Structure; modificationTime>`
      Time when the file's contents were last modified. See :doc:`/api/timestamps`.

   :index:`executable <pair: File Mapping Structure; executable>`
      The file is marked as executable.
