.. _simon:

:mod:`sightline.simon` --- DTaaS SDK
====================================

.. module:: sightline.simon
    :synopsis: DTaaS SDK

:class:`V1Resource`
-------------------

.. class:: sightline.simon.resource.V1Resource()

    A generic wrapper type that encompasses DTaaS API objects. Currently:

    - :class:`sightline.simon.data.Bucket`,
    - :class:`sightline.simon.data.Volume`,
    - :class:`sightline.simon.prototype.Prototype`,    
    - :class:`sightline.simon.servable.Servable` and its subclasses,
    - :class:`sightline.simon.instance.Instance`,
    - :class:`sightline.simon.federation.Federation`,
    - :class:`sightline.simon.federation.Peer`

:class:`V1Status`
-------------------

.. class:: sightline.simon.resource.V1Status()
    
    A Result type that can be one of ``V1Status.OK`` or ``V1Status.ERR``.

    - .. method:: which()

        Returns ``V1Status.OK`` or ``V1Status.ERR``
    
    - .. method:: ok()

        Returns the message associated with OK. Raises if not OK.
    
    - .. method:: err()

        Returns the message associated with ERR.

:class:`V1Error`
----------------

.. class:: sightline.simon.resource.V1Error()

    An Exception type that is used for errors when interacting with
    :class:`V1Resource` APIs.


Prototypes
----------

- :ref:`Prototype API <prototype>`


Servables
---------

- :ref:`Servable API <servable>`

  - :ref:`App <app>`
  - :ref:`Daemon <daemon>`
  - :ref:`Dataset <dataset>`
  - :ref:`Model <model>`
  - :ref:`Pipeline <pipeline>`
  - :ref:`Report <report>`

Note that the top-level Servable API should not be used directly. The different
kinds of Servables subclass this API, and they should be used instead. All
Servables have the same API.


Instances
---------

- :ref:`Instance API <instance>`
- :ref:`Utility Functions <util>`

Data
----

- :ref:`Buckets and Volumes <data>`

.. _trusts:

Trusts
------

- :ref:`Trust API <trust-api>`

Capabilities
------------

- :ref:`Capability API <capabilities>`

Federations
-----------

- :ref:`Federation API <federations>`