.. _step-SaveToCache:


SaveToCache
===========

Step takes any input data and saves it to a cache with the specified key. The key the data was saved with is saved for the next step

.. versionadded:: 1.0.0

* **Friendly name:** ``Cache Save``
* **Step class:** ``base_steps_syncpack.steps.SaveToCache.SaveToCache``
* **Step version:** ``1.0.3``
* **Required parameters:** ``save_key``

Parameters
----------

.. list-table::
   :header-rows: 1
   :widths: 22 16 8 16 38

   * - Name
     - Type
     - Required
     - Default
     - Description
   * - ``save_key``
     - string
     - yes
     - --
     - The key for which to save this data with Example: ``keyA``
   * - ``parse_only``
     - string (multi-line)
     - no
     - --
     - Only save data from a specific key
   * - ``chunk_size``
     - number
     - no
     - ``5000``
     - Advanced value for specifying how many items should be in the chunked setsif the data is larger than the 20mb limit. Example: ``10``
   * - ``read_from_api``
     - boolean
     - no
     - ``False``
     - Cache available for being requested from the API

Every step also accepts the platform parameters common to all steps --
see :ref:`platform-parameters`.

Dependencies
------------

* **Inherits from:** ``SaveToCache`` -> ``BaseStep`` -> ``Serializable``
* **External packages:** ``ipaascommon``, ``ipaascore``, ``isbaseutils``

.. include:: /_step_notes/SaveToCache.rst

API
---

.. autoclass:: base_steps_syncpack.steps.SaveToCache.SaveToCache
   :members:
   :show-inheritance: