DNS Zone
========

DNS Zones are responsible for housing all zone and record information associated for a particular zone. 
This resource inherits from Resource 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)                                               |
+-------------------------+-------------------------------------------------------------------------------------------------+
| id                      | The provider ID of the zone                                                                     |
+-------------------------+-------------------------------------------------------------------------------------------------+
| domain                  | The domain that the zone controls                                                               |
+-------------------------+-------------------------------------------------------------------------------------------------+
| comment                 | A descriptive comment about the zone                                                            |
+-------------------------+-------------------------------------------------------------------------------------------------+
| private_zone            | Denotes whether or not this is a private zone                                                   |
+-------------------------+-------------------------------------------------------------------------------------------------+
| records                 | Returns a listing of DNS records associated with this zone                                      |
+-------------------------+-------------------------------------------------------------------------------------------------+
| networks                | Returns a listing of private networks that are associated with this zone                        |
+-------------------------+-------------------------------------------------------------------------------------------------+

.. container:: magic-block-textarea

   **DNS Zone 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.

   ``dns_zone``

   ``static get_db_class()``

   | ``get_domain()``
   | Retrieve the domain of the DNS zone.

   | ``get_networks()``
   | Retrieve the networks associated with a
     private zone.

   | ``get_private_zone()``
   | Retrieve the value of the private zone
     boolean.

   ``static get_provider_id_field()``

   ``get_resource_name()``

   ``static get_resource_name_field()``

   ``static get_resource_type()``

   ``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 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.

   ``top_level_resource = True``

   ``zone_id``