
.. _structure-garbage-collect:

:index:`Garbage Collect Structure`
------------------------------------------------

A Garbage Collect Structure is returned as the result from :meth:`~jetstream.serverinterface.ServerInterface.getGarbageCollectSettings` and :meth:`~jetstream.serverinterface.ServerInterface.updateGarbageCollectSettings`, and is also included in the :ref:`structure-server-info`.
 
.. glossary::
   :sorted:

   :index:`intervalSeconds <pair: Garbage Collect Structure; intervalSeconds>`
      The time, in seconds, between each garbage collection. Allowed range is from 60 (1 minute) to 2147483647 (about 68 years).
    
   :index:`timeLimitSeconds <pair: Garbage Collect Structure; timeLimitSeconds>`
      The grace period, in seconds, to allow for items that are ready to be garbage collected. If 0, all eligible items will be discarded immediately. If non-zero, keep items that have been ready for garbage collection for less time than specified. Allowed range is from 0 to 2147483647 (about 68 years).

.. versionchanged:: 1.8.0 Added to API.
