Memcache Snapshot
=================

Memcache Snapshots are point in time backups of a memcache instance. 
This class inherits from TopLevelResource and has direct access to the resource’s database object.

+-------------------------+-------------------------------------------------------------------------------------------------+
| Attribute               | Description                                                                                     |
+=========================+=================================================================================================+
| resource_id             | The primary resource identifier that takes the form of a prefix followed by numbers and letters |
+-------------------------+-------------------------------------------------------------------------------------------------+
| organization_service_id | The ID of the parent organization service (cloud)                                               |
+-------------------------+-------------------------------------------------------------------------------------------------+
| region_name             | The region that the snapshot resides in                                                         |
+-------------------------+-------------------------------------------------------------------------------------------------+
| snapshot_id             | The provider ID of the snapshot                                                                 |
+-------------------------+-------------------------------------------------------------------------------------------------+
| name                    | The name of the volume                                                                          |
+-------------------------+-------------------------------------------------------------------------------------------------+
| snapshot_type           | The type of snapshot (manual vs automatic)                                                      |
+-------------------------+-------------------------------------------------------------------------------------------------+
| state                   | The current lifecycle state of the snapshot                                                     |
+-------------------------+-------------------------------------------------------------------------------------------------+
| availability_zone       | The zone where the snapshot lives                                                               |
+-------------------------+-------------------------------------------------------------------------------------------------+
| create_time             | The time when the snapshot creation was launched                                                |
+-------------------------+-------------------------------------------------------------------------------------------------+
| port                    | The port that the database instance listens on                                                  |
+-------------------------+-------------------------------------------------------------------------------------------------+
| engine                  | The database engine that the instance was configured to use                                     |
+-------------------------+-------------------------------------------------------------------------------------------------+
| engine_version          | The engine version                                                                              |
+-------------------------+-------------------------------------------------------------------------------------------------+
| size                    | The size in gigabytes of the volume                                                             |
+-------------------------+-------------------------------------------------------------------------------------------------+
| progress                | The progress of the snapshot creation                                                           |
+-------------------------+-------------------------------------------------------------------------------------------------+

.. container:: magic-block-textarea

   **Memcache Instance Snapshot Operations**

   | ``delete(user_resource_id=None)``
   | Delete this resource. If wrapped in a with
     JobQueue() block, this will queue the deletion
     job to the wrapped queue, otherwise it calls
     immediately.

   | ``get_date_created()``
   | Retrieve the time from the provider that this
     resource was created (if available).

   ``static get_db_class()``

   ``get_parent_resource_id()``

   ``static get_provider_id_field()``

   ``static get_resource_type()``

   | ``get_state()``
   | Retrieve the snapshot state.

   ``get_supported_actions()``

   | ``handle_resource_created(user_resource_id=None, project_resource_id=None)``
   | This should be called when a resource is
     created/discovered after the basic data is
     added to the database. This gives an
     opportunity for post-addition hooks
     (assignment to groups, alerts, etc).

   | ``handle_resource_destroyed(user_resource_id=None)``
   | This should be called when a resource is
     destroyed before the basic data is removed
     from the database. This gives an opportunity
     for pre-destruction hooks (removal from
     projects/groups, alerts, etc).

   | ``handle_resource_modified(resource, *args, **kwargs)``
   | This should be called when a resource is
     modified after the new data has been updated
     in the DB session. This gives an opportunity
     for post-modification hooks.

   ``snapshot``

   ``top_level_resource = True``